History

Ensuring minimal documentation for classes declared in script-engine

Heather Anderson committed 5 years ago

Commit 259cd201 parent f1b4c8e41 files · +211 −63Browse files

Showing the changes to libraries/script-engine/src/ScriptUUID.h (1 of 41 files). Show all

Unified · Split

libraries/script-engine/src/ScriptUUID.h+5−3
@@ -10,7 +10,9 @@ · 9 unmodified lines
10// Distributed under the Apache License, Version 2.0.10// Distributed under the Apache License, Version 2.0.
11// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html11// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
12//12//
13 13/** @addtogroup ScriptEngine
14 * @{
15*/
14#ifndef hifi_ScriptUUID_h16#ifndef hifi_ScriptUUID_h
15#define hifi_ScriptUUID_h17#define hifi_ScriptUUID_h
16 18
@@ -32,8 +34,7 @@ · 15 unmodified lines
32 *34 *
33 * @property {Uuid} NULL - The null UUID, <code>"{00000000-0000-0000-0000-000000000000}"</code>.35 * @property {Uuid} NULL - The null UUID, <code>"{00000000-0000-0000-0000-000000000000}"</code>.
34 */36 */
35 37/// Provides the <code><a href="https://apidocs.vircadia.dev/Uuid.html">Uuid</a></code> scripting interface
36/// Scriptable interface for a UUID helper class object. Used exclusively in the JavaScript API
37class ScriptUUID : public QObject, protected QScriptable {38class ScriptUUID : public QObject, protected QScriptable {
38 Q_OBJECT39 Q_OBJECT
39 Q_PROPERTY(QString NULL READ NULL_UUID CONSTANT) // String for use in scripts.40 Q_PROPERTY(QString NULL READ NULL_UUID CONSTANT) // String for use in scripts.
@@ -127,3 +128,4 @@ private: · 87 unmodified lines
127};128};
128 129
129#endif // hifi_ScriptUUID_h130#endif // hifi_ScriptUUID_h
131/** @}*/