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
1010 // Distributed under the Apache License, Version 2.0.
1111 // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
1212 //
13−
13+/** @addtogroup ScriptEngine
14+ * @{
15+*/
1416 #ifndef hifi_ScriptUUID_h
1517 #define hifi_ScriptUUID_h
1618
@@ -32,8 +34,7 @@ · 15 unmodified lines
3234 *
3335 * @property {Uuid} NULL - The null UUID, <code>"{00000000-0000-0000-0000-000000000000}"</code>.
3436 */
35−
36−/// Scriptable interface for a UUID helper class object. Used exclusively in the JavaScript API
37+/// Provides the <code><a href="https://apidocs.vircadia.dev/Uuid.html">Uuid</a></code> scripting interface
3738 class ScriptUUID : public QObject, protected QScriptable {
3839 Q_OBJECT
3940 Q_PROPERTY(QString NULL READ NULL_UUID CONSTANT) // String for use in scripts.
@@ -127,3 +128,4 @@ private: · 87 unmodified lines
127128 };
128129
129130 #endif // hifi_ScriptUUID_h
131+/** @}*/