History

Convert all "/**jsdoc" occurrences to "/*@jsdoc"

David Rowe committed 5 years ago

Commit 4d11d1d1 parent 2130dea220 files · +2319 −2319Browse files

Showing the changes to libraries/script-engine/src/ScriptEngine.cpp (1 of 220 files). Show all

Unified · Split

libraries/script-engine/src/ScriptEngine.cpp+8−8
@@ -675,7 +675,7 @@ static void scriptableResourceFromScriptValue(const QScriptValue& value, Scripta · 674 unmodified lines
675675 resource = static_cast<ScriptableResourceRawPtr>(value.toQObject());
676676 }
677677
678−/**jsdoc
678+/*@jsdoc
679679 * The <code>Resource</code> API provides values that define the possible loading states of a resource.
680680 *
681681 * @namespace Resource
@@ -797,7 +797,7 @@ void ScriptEngine::init() { · 115 unmodified lines
797797 QScriptValue webSocketConstructorValue = newFunction(WebSocketClass::constructor);
798798 globalObject().setProperty("WebSocket", webSocketConstructorValue);
799799
800− /**jsdoc
800+ /*@jsdoc
801801 * Prints a message to the program log and emits {@link Script.printedMessage}.
802802 * The message logged is the message values separated by spaces.
803803 * <p>Alternatively, you can use {@link Script.print} or one of the {@link console} API methods.</p>
@@ -1097,7 +1097,7 @@ void ScriptEngine::addEventHandler(const EntityItemID& entityID, const QString& · 293 unmodified lines
10971097
10981098 // Two common cases of event handler, differing only in argument signature.
10991099
1100− /**jsdoc
1100+ /*@jsdoc
11011101 * Called when an entity event occurs on an entity as registered with {@link Script.addEventHandler}.
11021102 * @callback Script~entityEventCallback
11031103 * @param {Uuid} entityID - The ID of the entity the event has occured on.
@@ -1109,7 +1109,7 @@ void ScriptEngine::addEventHandler(const EntityItemID& entityID, const QString& · 5 unmodified lines
11091109 };
11101110 };
11111111
1112− /**jsdoc
1112+ /*@jsdoc
11131113 * Called when a pointer event occurs on an entity as registered with {@link Script.addEventHandler}.
11141114 * @callback Script~pointerEventCallback
11151115 * @param {Uuid} entityID - The ID of the entity the event has occurred on.
@@ -1124,7 +1124,7 @@ void ScriptEngine::addEventHandler(const EntityItemID& entityID, const QString& · 8 unmodified lines
11241124 };
11251125 };
11261126
1127− /**jsdoc
1127+ /*@jsdoc
11281128 * Called when a collision event occurs on an entity as registered with {@link Script.addEventHandler}.
11291129 * @callback Script~collisionEventCallback
11301130 * @param {Uuid} entityA - The ID of one entity in the collision.
@@ -1139,7 +1139,7 @@ void ScriptEngine::addEventHandler(const EntityItemID& entityID, const QString& · 8 unmodified lines
11391139 };
11401140 };
11411141
1142− /**jsdoc
1142+ /*@jsdoc
11431143 * <p>The name of an entity event. When the entity event occurs, any function that has been registered for that event
11441144 * via {@link Script.addEventHandler} is called with parameters per the entity event.</p>
11451145 * <table>
@@ -2349,7 +2349,7 @@ void ScriptEngine::loadEntityScript(const EntityItemID& entityID, const QString& · 1203 unmodified lines
23492349 }, forceRedownload);
23502350 }
23512351
2352−/**jsdoc
2352+/*@jsdoc
23532353 * Triggered when the script starts for a user. See also, {@link Script.entityScriptPreloadFinished}.
23542354 * <p>Note: Can only be connected to via <code>this.preload = function (...) { ... }</code> in the entity script.</p>
23552355 * <p class="availableIn"><strong>Supported Script Types:</strong> Client Entity Scripts &bull; Server Entity Scripts</p>
@@ -2636,7 +2636,7 @@ void ScriptEngine::entityScriptContentAvailable(const EntityItemID& entityID, co · 280 unmodified lines
26362636 emit entityScriptPreloadFinished(entityID);
26372637 }
26382638
2639−/**jsdoc
2639+/*@jsdoc
26402640 * Triggered when the script terminates for a user.
26412641 * <p>Note: Can only be connected to via <code>this.unoad = function () { ... }</code> in the entity script.</p>
26422642 * <p class="availableIn"><strong>Supported Script Types:</strong> Client Entity Scripts &bull; Server Entity Scripts</p>