History

adding basic script-engine documentation

Heather Anderson committed 5 years ago

Commit 1f4f4581 parent 2dd9d7822 files · +108 −54Browse files

Showing the changes to libraries/script-engine/src/qtscript/ScriptEngineQtScript.h (1 of 22 files). Show all

Unified · Split

libraries/script-engine/src/qtscript/ScriptEngineQtScript.h+8−34
@@ -10,6 +10,9 @@ · 9 unmodified lines
10// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html10// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
11//11//
12 12
13/// @addtogroup ScriptEngine
14/// @{
15
13#ifndef hifi_ScriptEngineQtScript_h16#ifndef hifi_ScriptEngineQtScript_h
14#define hifi_ScriptEngineQtScript_h17#define hifi_ScriptEngineQtScript_h
15 18
@@ -35,40 +38,9 @@ class ScriptManager; · 19 unmodified lines
35using ScriptEngineQtScriptPointer = QSharedPointer<ScriptEngineQtScript>;38using ScriptEngineQtScriptPointer = QSharedPointer<ScriptEngineQtScript>;
36using ScriptContextQtPointer = QSharedPointer<ScriptContextQtWrapper>;39using ScriptContextQtPointer = QSharedPointer<ScriptContextQtWrapper>;
37 40
38Q_DECLARE_METATYPE(ScriptEngineQtScriptPointer)41Q_DECLARE_METATYPE(ScriptEngineQtScriptPointer);
39 42
40/**jsdoc43/// [QtScript] Implements ScriptEngine for QtScript and translates calls for QScriptEngine
41 * The <code>Script</code> API provides facilities for working with scripts.
42 *
43 * @namespace Script
44 *
45 * @hifi-interface
46 * @hifi-client-entity
47 * @hifi-avatar
48 * @hifi-server-entity
49 * @hifi-assignment-client
50 *
51 * @property {string} context - The context that the script is running in:
52 * <ul>
53 * <li><code>"client"</code>: An Interface or avatar script.</li>
54 * <li><code>"entity_client"</code>: A client entity script.</li>
55 * <li><code>"entity_server"</code>: A server entity script.</li>
56 * <li><code>"agent"</code>: An assignment client script.</li>
57 * </ul>
58 * <em>Read-only.</em>
59 * @property {string} type - The type of script that is running:
60 * <ul>
61 * <li><code>"client"</code>: An Interface script.</li>
62 * <li><code>"entity_client"</code>: A client entity script.</li>
63 * <li><code>"avatar"</code>: An avatar script.</li>
64 * <li><code>"entity_server"</code>: A server entity script.</li>
65 * <li><code>"agent"</code>: An assignment client script.</li>
66 * </ul>
67 * <em>Read-only.</em>
68 * @property {string} filename - The filename of the script file.
69 * <em>Read-only.</em>
70 * @property {Script.ResourceBuckets} ExternalPaths - External resource buckets.
71 */
72class ScriptEngineQtScript : public QScriptEngine, public ScriptEngine, public QEnableSharedFromThis<ScriptEngineQtScript> {44class ScriptEngineQtScript : public QScriptEngine, public ScriptEngine, public QEnableSharedFromThis<ScriptEngineQtScript> {
73 Q_OBJECT45 Q_OBJECT
74 46
@@ -467,3 +439,5 @@ private: · 392 unmodified lines
467};439};
468 440
469#endif // hifi_ScriptEngineQtScript_h441#endif // hifi_ScriptEngineQtScript_h
442
443/// @}

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t