diff --git a/libraries/script-engine/src/AbstractScriptingServicesInterface.h b/libraries/script-engine/src/AbstractScriptingServicesInterface.h
index ac26b166b6..e8a2d6b38e 100644
--- a/libraries/script-engine/src/AbstractScriptingServicesInterface.h
+++ b/libraries/script-engine/src/AbstractScriptingServicesInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_AbstractScriptingServicesInterface_h
#define hifi_AbstractScriptingServicesInterface_h
@@ -23,3 +25,4 @@ public:
#endif // hifi_AbstractScriptingServicesInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/ArrayBufferClass.h b/libraries/script-engine/src/ArrayBufferClass.h
index 295b9c3fa4..380b7bb859 100644
--- a/libraries/script-engine/src/ArrayBufferClass.h
+++ b/libraries/script-engine/src/ArrayBufferClass.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ArrayBufferClass_h
#define hifi_ArrayBufferClass_h
@@ -23,6 +25,7 @@
class ScriptEngine;
+/// Implements the ArrayBuffer
scripting class
class ArrayBufferClass : public QObject, public QScriptClass {
Q_OBJECT
public:
@@ -58,3 +61,4 @@ private:
};
#endif // hifi_ArrayBufferClass_h
+/** @}*/
diff --git a/libraries/script-engine/src/ArrayBufferPrototype.h b/libraries/script-engine/src/ArrayBufferPrototype.h
index f9dd667dc4..b69c902e23 100644
--- a/libraries/script-engine/src/ArrayBufferPrototype.h
+++ b/libraries/script-engine/src/ArrayBufferPrototype.h
@@ -8,13 +8,16 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ArrayBufferPrototype_h
#define hifi_ArrayBufferPrototype_h
#include
#include
+/// The javascript functions associated with an ArrayBuffer
instance prototype
class ArrayBufferPrototype : public QObject, public QScriptable {
Q_OBJECT
public:
@@ -30,4 +33,5 @@ private:
QByteArray* thisArrayBuffer() const;
};
-#endif // hifi_ArrayBufferPrototype_h
\ No newline at end of file
+#endif // hifi_ArrayBufferPrototype_h
+/** @}*/
diff --git a/libraries/script-engine/src/ArrayBufferViewClass.h b/libraries/script-engine/src/ArrayBufferViewClass.h
index 67af4a3fc3..7e56373360 100644
--- a/libraries/script-engine/src/ArrayBufferViewClass.h
+++ b/libraries/script-engine/src/ArrayBufferViewClass.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ArrayBufferViewClass_h
#define hifi_ArrayBufferViewClass_h
@@ -26,6 +28,7 @@ static const QString BUFFER_PROPERTY_NAME = "buffer";
static const QString BYTE_OFFSET_PROPERTY_NAME = "byteOffset";
static const QString BYTE_LENGTH_PROPERTY_NAME = "byteLength";
+/// The base class containing common code for ArrayBuffer views
class ArrayBufferViewClass : public QObject, public QScriptClass {
Q_OBJECT
public:
@@ -50,3 +53,4 @@ protected:
};
#endif // hifi_ArrayBufferViewClass_h
+/** @}*/
diff --git a/libraries/script-engine/src/AssetScriptingInterface.h b/libraries/script-engine/src/AssetScriptingInterface.h
index 5ec53e913e..78fe2b0f49 100644
--- a/libraries/script-engine/src/AssetScriptingInterface.h
+++ b/libraries/script-engine/src/AssetScriptingInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#pragma once
#ifndef hifi_AssetScriptingInterface_h
@@ -41,6 +43,7 @@
* @hifi-server-entity
* @hifi-assignment-client
*/
+/// Provides the Assets
scripting API
class AssetScriptingInterface : public BaseAssetScriptingInterface, QScriptable {
Q_OBJECT
public:
@@ -544,3 +547,4 @@ protected:
};
#endif // hifi_AssetScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/AudioScriptingInterface.h b/libraries/script-engine/src/AudioScriptingInterface.h
index 1a8f752861..e7d2d7f1cd 100644
--- a/libraries/script-engine/src/AudioScriptingInterface.h
+++ b/libraries/script-engine/src/AudioScriptingInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_AudioScriptingInterface_h
#define hifi_AudioScriptingInterface_h
@@ -19,6 +21,7 @@
class ScriptAudioInjector;
+/// Provides the Audio
scripting API
class AudioScriptingInterface : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY
@@ -290,3 +293,4 @@ private:
void registerAudioMetaTypes(QScriptEngine* engine);
#endif // hifi_AudioScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/BatchLoader.h b/libraries/script-engine/src/BatchLoader.h
index 3affacc07d..eaad03272d 100644
--- a/libraries/script-engine/src/BatchLoader.h
+++ b/libraries/script-engine/src/BatchLoader.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_BatchLoader_h
#define hifi_BatchLoader_h
@@ -23,6 +25,7 @@
#include
+// Proxy object internal to BatchLoader
to ensure threadsafety during loading actions
class ScriptCacheSignalProxy : public QObject {
Q_OBJECT
public:
@@ -32,6 +35,7 @@ signals:
void contentAvailable(const QString& url, const QString& contents, bool isURL, bool success, const QString& status);
};
+/// Load one or more files for use by the scripting engine
class BatchLoader : public QObject {
Q_OBJECT
public:
@@ -54,3 +58,4 @@ private:
};
#endif // hifi_BatchLoader_h
+/** @}*/
diff --git a/libraries/script-engine/src/ConsoleScriptingInterface.h b/libraries/script-engine/src/ConsoleScriptingInterface.h
index 1e56526cd1..107017f1d9 100644
--- a/libraries/script-engine/src/ConsoleScriptingInterface.h
+++ b/libraries/script-engine/src/ConsoleScriptingInterface.h
@@ -14,7 +14,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#pragma once
#ifndef hifi_ConsoleScriptingInterface_h
#define hifi_ConsoleScriptingInterface_h
@@ -37,7 +39,7 @@
* @hifi-server-entity
* @hifi-assignment-client
*/
-// Scriptable interface of "console" object. Used exclusively in the JavaScript API
+/// Provides the console
scripting API
class ConsoleScriptingInterface : public QObject, protected QScriptable {
Q_OBJECT
public:
@@ -220,3 +222,4 @@ private:
};
#endif // hifi_ConsoleScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/DataViewClass.h b/libraries/script-engine/src/DataViewClass.h
index 72c920a727..f5fa8b8b0d 100644
--- a/libraries/script-engine/src/DataViewClass.h
+++ b/libraries/script-engine/src/DataViewClass.h
@@ -8,12 +8,15 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_DataViewClass_h
#define hifi_DataViewClass_h
#include "ArrayBufferViewClass.h"
+/// Implements the DataView
scripting class
class DataViewClass : public ArrayBufferViewClass {
Q_OBJECT
public:
@@ -34,3 +37,4 @@ private:
#endif // hifi_DataViewClass_h
+/** @}*/
diff --git a/libraries/script-engine/src/DataViewPrototype.h b/libraries/script-engine/src/DataViewPrototype.h
index da0261dad4..7981a0b433 100644
--- a/libraries/script-engine/src/DataViewPrototype.h
+++ b/libraries/script-engine/src/DataViewPrototype.h
@@ -8,13 +8,16 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_DataViewPrototype_h
#define hifi_DataViewPrototype_h
#include
#include
+/// The javascript functions associated with a DataView
instance prototype
class DataViewPrototype : public QObject, public QScriptable {
Q_OBJECT
public:
@@ -65,4 +68,5 @@ private:
bool realOffset(qint32& offset, size_t size) const;
};
-#endif // hifi_DataViewPrototype_h
\ No newline at end of file
+#endif // hifi_DataViewPrototype_h
+/** @}*/
diff --git a/libraries/script-engine/src/EventTypes.h b/libraries/script-engine/src/EventTypes.h
index 906006e4f4..0affc12595 100644
--- a/libraries/script-engine/src/EventTypes.h
+++ b/libraries/script-engine/src/EventTypes.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_EventTypes_h
#define hifi_EventTypes_h
@@ -17,3 +19,4 @@
void registerEventTypes(QScriptEngine* engine);
#endif // hifi_EventTypes_h
+/** @}*/
diff --git a/libraries/script-engine/src/FileScriptingInterface.h b/libraries/script-engine/src/FileScriptingInterface.h
index 4bc73346ac..5a1b6097e7 100644
--- a/libraries/script-engine/src/FileScriptingInterface.h
+++ b/libraries/script-engine/src/FileScriptingInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_FileScriptingInterface_h
#define hifi_FileScriptingInterface_h
@@ -27,7 +29,7 @@
* @hifi-server-entity
* @hifi-assignment-client
*/
-
+/// Provides the File
scripting API
class FileScriptingInterface : public QObject {
Q_OBJECT
@@ -113,4 +115,5 @@ private:
};
-#endif // hifi_FileScriptingInterface_h
\ No newline at end of file
+#endif // hifi_FileScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/KeyEvent.h b/libraries/script-engine/src/KeyEvent.h
index 350b733eaf..d8eda8d1d2 100644
--- a/libraries/script-engine/src/KeyEvent.h
+++ b/libraries/script-engine/src/KeyEvent.h
@@ -8,13 +8,16 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_KeyEvent_h
#define hifi_KeyEvent_h
#include
#include
+/// Represents a keyboard event to the scripting engine. Exposed as KeyEvent
class KeyEvent {
public:
KeyEvent();
@@ -38,4 +41,5 @@ public:
Q_DECLARE_METATYPE(KeyEvent)
-#endif // hifi_KeyEvent_h
\ No newline at end of file
+#endif // hifi_KeyEvent_h
+/** @}*/
diff --git a/libraries/script-engine/src/MIDIEvent.h b/libraries/script-engine/src/MIDIEvent.h
index 6bf4a4b72b..1c2e133116 100644
--- a/libraries/script-engine/src/MIDIEvent.h
+++ b/libraries/script-engine/src/MIDIEvent.h
@@ -8,12 +8,15 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
-#include
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_MIDIEvent_h
#define hifi_MIDIEvent_h
+#include
+
+/// Represents a MIDI protocol event to the scripting engine.
class MIDIEvent {
public:
double deltaTime;
@@ -29,4 +32,5 @@ void registerMIDIMetaTypes(QScriptEngine* engine);
QScriptValue midiEventToScriptValue(QScriptEngine* engine, const MIDIEvent& event);
void midiEventFromScriptValue(const QScriptValue &object, MIDIEvent& event);
-#endif // hifi_MIDIEvent_h
\ No newline at end of file
+#endif // hifi_MIDIEvent_h
+/** @}*/
diff --git a/libraries/script-engine/src/Mat4.h b/libraries/script-engine/src/Mat4.h
index 93f83c427e..6087610abd 100644
--- a/libraries/script-engine/src/Mat4.h
+++ b/libraries/script-engine/src/Mat4.h
@@ -10,7 +10,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_Mat4_h
#define hifi_Mat4_h
@@ -35,8 +37,7 @@
* @hifi-server-entity
* @hifi-assignment-client
*/
-
-/// Scriptable Mat4 object. Used exclusively in the JavaScript API
+/// Provides the Mat4
scripting interface
class Mat4 : public QObject, protected QScriptable {
Q_OBJECT
@@ -321,3 +322,4 @@ public slots:
};
#endif // hifi_Mat4_h
+/** @}*/
diff --git a/libraries/script-engine/src/MenuItemProperties.h b/libraries/script-engine/src/MenuItemProperties.h
index 9de4337838..409eab5a8c 100644
--- a/libraries/script-engine/src/MenuItemProperties.h
+++ b/libraries/script-engine/src/MenuItemProperties.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_MenuItemProperties_h
#define hifi_MenuItemProperties_h
@@ -17,6 +19,7 @@
#include "KeyEvent.h"
+/// Represents a menu item a script may declare and bind events to. Exposed as MenuItemProperties
class MenuItemProperties {
public:
MenuItemProperties() {}
@@ -56,3 +59,4 @@ void registerMenuItemProperties(QScriptEngine* engine);
#endif // hifi_MenuItemProperties_h
+/** @}*/
diff --git a/libraries/script-engine/src/ModelScriptingInterface.h b/libraries/script-engine/src/ModelScriptingInterface.h
index f936ca900c..eab85f13d5 100644
--- a/libraries/script-engine/src/ModelScriptingInterface.h
+++ b/libraries/script-engine/src/ModelScriptingInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ModelScriptingInterface_h
#define hifi_ModelScriptingInterface_h
@@ -32,6 +34,7 @@ class QScriptEngine;
*
* @deprecated This API is deprecated. Use the {@link Graphics} API instead.
*/
+/// Provides the Model
scripting interface
class ModelScriptingInterface : public QObject {
Q_OBJECT
@@ -97,3 +100,4 @@ private:
};
#endif // hifi_ModelScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/MouseEvent.h b/libraries/script-engine/src/MouseEvent.h
index d9b00a8e01..3f7031c2ff 100644
--- a/libraries/script-engine/src/MouseEvent.h
+++ b/libraries/script-engine/src/MouseEvent.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_MouseEvent_h
#define hifi_MouseEvent_h
@@ -17,6 +19,7 @@
class QScriptEngine;
+/// Represents a mouse event to the scripting engine. Exposed as MouseEvent
class MouseEvent {
public:
MouseEvent();
@@ -42,3 +45,4 @@ public:
Q_DECLARE_METATYPE(MouseEvent)
#endif // hifi_MouseEvent_h
+/** @}*/
diff --git a/libraries/script-engine/src/Quat.h b/libraries/script-engine/src/Quat.h
index d603e5a800..535f42ffea 100644
--- a/libraries/script-engine/src/Quat.h
+++ b/libraries/script-engine/src/Quat.h
@@ -10,7 +10,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_Quat_h
#define hifi_Quat_h
@@ -51,8 +53,7 @@
* print(JSON.stringify(Quat.IDENTITY)); // { x: 0, y: 0, z: 0, w: 1 }
* print(JSON.stringify(Quat.safeEulerAngles(Quat.IDENTITY))); // { x: 0, y: 0, z: 0 }
*/
-
-/// Scriptable interface a Quaternion helper class object. Used exclusively in the JavaScript API
+/// Provides the Quat
scripting interface
class Quat : public QObject, protected QScriptable {
Q_OBJECT
Q_PROPERTY(glm::quat IDENTITY READ IDENTITY CONSTANT)
@@ -470,3 +471,4 @@ private:
};
#endif // hifi_Quat_h
+/** @}*/
diff --git a/libraries/script-engine/src/RecordingScriptingInterface.h b/libraries/script-engine/src/RecordingScriptingInterface.h
index b9a7d1db83..ca099835f3 100644
--- a/libraries/script-engine/src/RecordingScriptingInterface.h
+++ b/libraries/script-engine/src/RecordingScriptingInterface.h
@@ -5,7 +5,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_RecordingScriptingInterface_h
#define hifi_RecordingScriptingInterface_h
@@ -34,6 +36,7 @@ class QScriptValue;
* @hifi-avatar
* @hifi-assignment-client
*/
+/// Provides the Recording
scripting interface
class RecordingScriptingInterface : public QObject, public Dependency {
Q_OBJECT
@@ -369,3 +372,4 @@ private:
};
#endif // hifi_RecordingScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/SceneScriptingInterface.h b/libraries/script-engine/src/SceneScriptingInterface.h
index 817a89753b..0558506e02 100644
--- a/libraries/script-engine/src/SceneScriptingInterface.h
+++ b/libraries/script-engine/src/SceneScriptingInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_SceneScriptingInterface_h
#define hifi_SceneScriptingInterface_h
@@ -28,6 +30,7 @@
* @property {boolean} shouldRenderEntities - true
if entities (domain, avatar, and local) are rendered,
* false
if they aren't.
*/
+/// Provides the Scene
scripting interface
class SceneScriptingInterface : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY
@@ -69,3 +72,4 @@ protected:
};
#endif // hifi_SceneScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptAudioInjector.h b/libraries/script-engine/src/ScriptAudioInjector.h
index 8ed5956fea..dba7ca7fa9 100644
--- a/libraries/script-engine/src/ScriptAudioInjector.h
+++ b/libraries/script-engine/src/ScriptAudioInjector.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptAudioInjector_h
#define hifi_ScriptAudioInjector_h
@@ -35,6 +37,7 @@
* Read-only.
* @property {AudioInjector.AudioInjectorOptions} options - Configures how the injector plays the audio.
*/
+/// Provides the AudioInjector
scripting interface
class ScriptAudioInjector : public QObject {
Q_OBJECT
@@ -148,3 +151,4 @@ QScriptValue injectorToScriptValue(QScriptEngine* engine, ScriptAudioInjector* c
void injectorFromScriptValue(const QScriptValue& object, ScriptAudioInjector*& out);
#endif // hifi_ScriptAudioInjector_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptCache.h b/libraries/script-engine/src/ScriptCache.h
index 4ab4458ee9..91647cb8cd 100644
--- a/libraries/script-engine/src/ScriptCache.h
+++ b/libraries/script-engine/src/ScriptCache.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptCache_h
#define hifi_ScriptCache_h
@@ -32,7 +34,7 @@ public:
int maxRetries { MAX_RETRIES };
};
-/// Interface for loading scripts
+/// Dependency for for loading and caching scripts
class ScriptCache : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY
@@ -65,3 +67,4 @@ private:
};
#endif // hifi_ScriptCache_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h
index 2618ba9f00..2318c70cea 100644
--- a/libraries/script-engine/src/ScriptEngine.h
+++ b/libraries/script-engine/src/ScriptEngine.h
@@ -9,7 +9,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptEngine_h
#define hifi_ScriptEngine_h
@@ -133,6 +135,7 @@ public:
* Read-only.
* @property {Script.ResourceBuckets} ExternalPaths - External resource buckets.
*/
+/// The main class managing a scripting engine. Also provides the Script
scripting interface
class ScriptEngine : public BaseScriptEngine, public EntitiesScriptEngineProvider {
Q_OBJECT
Q_PROPERTY(QString context READ getContext)
@@ -1012,3 +1015,4 @@ ScriptEnginePointer scriptEngineFactory(ScriptEngine::Context context,
const QString& fileNameString);
#endif // hifi_ScriptEngine_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptEngineLogging.h b/libraries/script-engine/src/ScriptEngineLogging.h
index 3096dd4927..3163992f77 100644
--- a/libraries/script-engine/src/ScriptEngineLogging.h
+++ b/libraries/script-engine/src/ScriptEngineLogging.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptEngineLogging_h
#define hifi_ScriptEngineLogging_h
@@ -19,4 +21,4 @@ Q_DECLARE_LOGGING_CATEGORY(scriptengine_module)
Q_DECLARE_LOGGING_CATEGORY(scriptengine_script)
#endif // hifi_ScriptEngineLogging_h
-
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptEngines.h b/libraries/script-engine/src/ScriptEngines.h
index 13e0cb2e21..47e46767fb 100644
--- a/libraries/script-engine/src/ScriptEngines.h
+++ b/libraries/script-engine/src/ScriptEngines.h
@@ -5,7 +5,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptEngines_h
#define hifi_ScriptEngines_h
@@ -49,7 +51,7 @@ class ScriptEngine;
* scripts directory of the Interface installation.
* Read-only.
*/
-
+/// Provides the ScriptDiscoveryService
scripting interface
class ScriptEngines : public QObject, public Dependency, public ScriptInitializerMixin {
Q_OBJECT
@@ -362,3 +364,4 @@ QString expandScriptPath(const QString& rawPath);
QUrl expandScriptUrl(const QUrl& rawScriptURL);
#endif // hifi_ScriptEngine_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptGatekeeper.h b/libraries/script-engine/src/ScriptGatekeeper.h
index 22bda8d5d5..5767a20b35 100644
--- a/libraries/script-engine/src/ScriptGatekeeper.h
+++ b/libraries/script-engine/src/ScriptGatekeeper.h
@@ -8,12 +8,15 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef vircadia_ScriptGatekeeper_h
#define vircadia_ScriptGatekeeper_h
#include
+/// Manages script whitelisting in a domain
class ScriptGatekeeper : public QObject {
Q_OBJECT
public:
@@ -27,3 +30,4 @@ private:
};
#endif // vircadia_ScriptGatekeeper_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptUUID.h b/libraries/script-engine/src/ScriptUUID.h
index 27e5cc0c7b..96fc10d133 100644
--- a/libraries/script-engine/src/ScriptUUID.h
+++ b/libraries/script-engine/src/ScriptUUID.h
@@ -10,7 +10,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptUUID_h
#define hifi_ScriptUUID_h
@@ -32,8 +34,7 @@
*
* @property {Uuid} NULL - The null UUID, "{00000000-0000-0000-0000-000000000000}"
.
*/
-
-/// Scriptable interface for a UUID helper class object. Used exclusively in the JavaScript API
+/// Provides the Uuid
scripting interface
class ScriptUUID : public QObject, protected QScriptable {
Q_OBJECT
Q_PROPERTY(QString NULL READ NULL_UUID CONSTANT) // String for use in scripts.
@@ -127,3 +128,4 @@ private:
};
#endif // hifi_ScriptUUID_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptsModel.h b/libraries/script-engine/src/ScriptsModel.h
index 5703b30d3d..96af67074f 100644
--- a/libraries/script-engine/src/ScriptsModel.h
+++ b/libraries/script-engine/src/ScriptsModel.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptsModel_h
#define hifi_ScriptsModel_h
@@ -119,6 +121,7 @@ public:
* print("Scripts:");
* printDirectory(null, 0, ""); // null index for the root directory.
*/
+/// Provides script file information available from the ScriptDiscoveryService
scripting interface
class ScriptsModel : public QAbstractItemModel {
Q_OBJECT
public:
@@ -191,3 +194,4 @@ private:
};
#endif // hifi_ScriptsModel_h
+/** @}*/
diff --git a/libraries/script-engine/src/ScriptsModelFilter.h b/libraries/script-engine/src/ScriptsModelFilter.h
index f6c2119647..9337792549 100644
--- a/libraries/script-engine/src/ScriptsModelFilter.h
+++ b/libraries/script-engine/src/ScriptsModelFilter.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_ScriptsModelFilter_h
#define hifi_ScriptsModelFilter_h
@@ -71,6 +73,7 @@
* print("Edit scripts:");
* printDirectory(null, 0, ""); // null index for the root directory.
*/
+/// Provides script file information available from the ScriptDiscoveryService
scripting interface
class ScriptsModelFilter : public QSortFilterProxyModel {
Q_OBJECT
public:
@@ -81,3 +84,4 @@ protected:
};
#endif // hifi_ScriptsModelFilter_h
+/** @}*/
diff --git a/libraries/script-engine/src/SpatialEvent.h b/libraries/script-engine/src/SpatialEvent.h
index e0fcc03824..d2d862cd4d 100644
--- a/libraries/script-engine/src/SpatialEvent.h
+++ b/libraries/script-engine/src/SpatialEvent.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_SpatialEvent_h
#define hifi_SpatialEvent_h
@@ -17,6 +19,7 @@
#include
+/// [unused] Represents a spatial event to the scripting engine
class SpatialEvent {
public:
SpatialEvent();
@@ -33,4 +36,5 @@ public:
Q_DECLARE_METATYPE(SpatialEvent)
-#endif // hifi_SpatialEvent_h
\ No newline at end of file
+#endif // hifi_SpatialEvent_h
+/** @}*/
diff --git a/libraries/script-engine/src/StackTestScriptingInterface.h b/libraries/script-engine/src/StackTestScriptingInterface.h
index 74e3290ddb..992b55963b 100644
--- a/libraries/script-engine/src/StackTestScriptingInterface.h
+++ b/libraries/script-engine/src/StackTestScriptingInterface.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#pragma once
#ifndef hifi_StackTestScriptingInterface_h
@@ -29,3 +31,4 @@ public:
};
#endif // hifi_StackTestScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/TouchEvent.h b/libraries/script-engine/src/TouchEvent.h
index 62cb1b1801..8bfccc53da 100644
--- a/libraries/script-engine/src/TouchEvent.h
+++ b/libraries/script-engine/src/TouchEvent.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_TouchEvent_h
#define hifi_TouchEvent_h
@@ -20,6 +22,7 @@
class QScriptValue;
class QScriptEngine;
+/// Represents a display or device event to the scripting engine. Exposed as TouchEvent
class TouchEvent {
public:
TouchEvent();
@@ -60,3 +63,4 @@ private:
Q_DECLARE_METATYPE(TouchEvent)
#endif // hifi_TouchEvent_h
+/** @}*/
diff --git a/libraries/script-engine/src/TypedArrayPrototype.h b/libraries/script-engine/src/TypedArrayPrototype.h
index 86d578ace0..d0d0a25415 100644
--- a/libraries/script-engine/src/TypedArrayPrototype.h
+++ b/libraries/script-engine/src/TypedArrayPrototype.h
@@ -8,12 +8,15 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_TypedArrayPrototype_h
#define hifi_TypedArrayPrototype_h
#include "ArrayBufferViewClass.h"
+/// The javascript functions associated with a TypedArray
instance prototype
class TypedArrayPrototype : public QObject, public QScriptable {
Q_OBJECT
public:
@@ -30,4 +33,5 @@ private:
QByteArray* thisArrayBuffer() const;
};
-#endif // hifi_TypedArrayPrototype_h
\ No newline at end of file
+#endif // hifi_TypedArrayPrototype_h
+/** @}*/
diff --git a/libraries/script-engine/src/TypedArrays.h b/libraries/script-engine/src/TypedArrays.h
index 141e7870d9..d8f16b5adb 100644
--- a/libraries/script-engine/src/TypedArrays.h
+++ b/libraries/script-engine/src/TypedArrays.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_TypedArrays_h
#define hifi_TypedArrays_h
@@ -27,6 +29,7 @@ static const QString UINT_32_ARRAY_CLASS_NAME = "Uint32Array";
static const QString FLOAT_32_ARRAY_CLASS_NAME = "Float32Array";
static const QString FLOAT_64_ARRAY_CLASS_NAME = "Float64Array";
+/// Implements the TypedArray
scripting class
class TypedArray : public ArrayBufferViewClass {
Q_OBJECT
public:
@@ -146,3 +149,4 @@ public:
};
#endif // hifi_TypedArrays_h
+/** @}*/
diff --git a/libraries/script-engine/src/UsersScriptingInterface.h b/libraries/script-engine/src/UsersScriptingInterface.h
index ccf5a1d693..eef5357740 100644
--- a/libraries/script-engine/src/UsersScriptingInterface.h
+++ b/libraries/script-engine/src/UsersScriptingInterface.h
@@ -9,7 +9,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#pragma once
#ifndef hifi_UsersScriptingInterface_h
@@ -38,6 +40,7 @@
* @property {BanFlags} BAN_BY_FINGERPRINT - Ban user by fingerprint. Read-only.
* @property {BanFlags} BAN_BY_IP - Ban user by IP address. Read-only.
*/
+/// Provides the Users
scripting interface
class UsersScriptingInterface : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY
@@ -262,3 +265,4 @@ private:
#endif // hifi_UsersScriptingInterface_h
+/** @}*/
diff --git a/libraries/script-engine/src/Vec3.h b/libraries/script-engine/src/Vec3.h
index f10b3fa9a9..ac3dddb1be 100644
--- a/libraries/script-engine/src/Vec3.h
+++ b/libraries/script-engine/src/Vec3.h
@@ -10,7 +10,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#pragma once
#ifndef hifi_Vec3_h
#define hifi_Vec3_h
@@ -71,8 +73,7 @@
* @property {Vec3} FRONT - { x: 0, y: 0, z: -1 }
: Unit vector in the "front" direction. Synonym for
* UNIT_NEG_Z
. Read-only.
*/
-
-/// Scriptable interface a Vec3ernion helper class object. Used exclusively in the JavaScript API
+/// Provides the Vec3
scripting interface
class Vec3 : public QObject, protected QScriptable {
Q_OBJECT
Q_PROPERTY(glm::vec3 UNIT_X READ UNIT_X CONSTANT)
@@ -419,3 +420,4 @@ private:
};
#endif // hifi_Vec3_h
+/** @}*/
diff --git a/libraries/script-engine/src/WebSocketClass.h b/libraries/script-engine/src/WebSocketClass.h
index bf3d015dbc..8af9cda056 100644
--- a/libraries/script-engine/src/WebSocketClass.h
+++ b/libraries/script-engine/src/WebSocketClass.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_WebSocketClass_h
#define hifi_WebSocketClass_h
@@ -78,6 +80,7 @@
* webSocket.send("Test message");
* };
*/
+/// Provides the WebSocket
scripting interface
class WebSocketClass : public QObject {
Q_OBJECT
Q_PROPERTY(QString binaryType READ getBinaryType WRITE setBinaryType)
@@ -254,3 +257,4 @@ QScriptValue wscReadyStateToScriptValue(QScriptEngine* engine, const WebSocketCl
void wscReadyStateFromScriptValue(const QScriptValue& object, WebSocketClass::ReadyState& readyState);
#endif // hifi_WebSocketClass_h
+/** @}*/
diff --git a/libraries/script-engine/src/WebSocketServerClass.h b/libraries/script-engine/src/WebSocketServerClass.h
index de6042b9da..11c7c85013 100644
--- a/libraries/script-engine/src/WebSocketServerClass.h
+++ b/libraries/script-engine/src/WebSocketServerClass.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_WebSocketServerClass_h
#define hifi_WebSocketServerClass_h
@@ -73,6 +75,7 @@
* webSocket.send(TEST_MESSAGE);
* };
*/
+/// Provides the WebSocketServer
scripting interface
class WebSocketServerClass : public QObject {
Q_OBJECT
Q_PROPERTY(QString url READ getURL)
@@ -118,3 +121,4 @@ signals:
};
#endif // hifi_WebSocketServerClass_h
+/** @}*/
diff --git a/libraries/script-engine/src/WheelEvent.h b/libraries/script-engine/src/WheelEvent.h
index 88ac828578..1cf66dd659 100644
--- a/libraries/script-engine/src/WheelEvent.h
+++ b/libraries/script-engine/src/WheelEvent.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_WheelEvent_h
#define hifi_WheelEvent_h
@@ -18,6 +20,7 @@
class QScriptValue;
class QScriptEngine;
+/// Represents a mouse wheel event to the scripting engine. Exposed as WheelEvent
class WheelEvent {
public:
WheelEvent();
@@ -42,3 +45,4 @@ public:
Q_DECLARE_METATYPE(WheelEvent)
#endif // hifi_WheelEvent_h
+/** @}*/
diff --git a/libraries/script-engine/src/XMLHttpRequestClass.h b/libraries/script-engine/src/XMLHttpRequestClass.h
index cf95bf1298..55495a72f8 100644
--- a/libraries/script-engine/src/XMLHttpRequestClass.h
+++ b/libraries/script-engine/src/XMLHttpRequestClass.h
@@ -8,7 +8,9 @@
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
-
+/** @addtogroup ScriptEngine
+ * @{
+*/
#ifndef hifi_XMLHttpRequestClass_h
#define hifi_XMLHttpRequestClass_h
@@ -149,6 +151,7 @@ XMlHttpRequest.getResponseHeader(QString) function
* req.open("GET", URL);
* req.send();
*/
+/// Provides the XMLHttpRequest
scripting interface
class XMLHttpRequestClass : public QObject {
Q_OBJECT
Q_PROPERTY(QScriptValue response READ getResponse)
@@ -374,3 +377,4 @@ private slots:
};
#endif // hifi_XMLHttpRequestClass_h
+/** @}*/