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
675 resource = static_cast<ScriptableResourceRawPtr>(value.toQObject());675 resource = static_cast<ScriptableResourceRawPtr>(value.toQObject());
676}676}
677 677
678/**jsdoc678/*@jsdoc
679 * The <code>Resource</code> API provides values that define the possible loading states of a resource.679 * The <code>Resource</code> API provides values that define the possible loading states of a resource.
680 *680 *
681 * @namespace Resource681 * @namespace Resource
@@ -797,7 +797,7 @@ void ScriptEngine::init() { · 115 unmodified lines
797 QScriptValue webSocketConstructorValue = newFunction(WebSocketClass::constructor);797 QScriptValue webSocketConstructorValue = newFunction(WebSocketClass::constructor);
798 globalObject().setProperty("WebSocket", webSocketConstructorValue);798 globalObject().setProperty("WebSocket", webSocketConstructorValue);
799 799
800 /**jsdoc800 /*@jsdoc
801 * Prints a message to the program log and emits {@link Script.printedMessage}.801 * Prints a message to the program log and emits {@link Script.printedMessage}.
802 * The message logged is the message values separated by spaces.802 * The message logged is the message values separated by spaces.
803 * <p>Alternatively, you can use {@link Script.print} or one of the {@link console} API methods.</p>803 * <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
1097 1097
1098 // Two common cases of event handler, differing only in argument signature.1098 // Two common cases of event handler, differing only in argument signature.
1099 1099
1100 /**jsdoc1100 /*@jsdoc
1101 * Called when an entity event occurs on an entity as registered with {@link Script.addEventHandler}.1101 * Called when an entity event occurs on an entity as registered with {@link Script.addEventHandler}.
1102 * @callback Script~entityEventCallback1102 * @callback Script~entityEventCallback
1103 * @param {Uuid} entityID - The ID of the entity the event has occured on.1103 * @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
1109 };1109 };
1110 };1110 };
1111 1111
1112 /**jsdoc1112 /*@jsdoc
1113 * Called when a pointer event occurs on an entity as registered with {@link Script.addEventHandler}.1113 * Called when a pointer event occurs on an entity as registered with {@link Script.addEventHandler}.
1114 * @callback Script~pointerEventCallback1114 * @callback Script~pointerEventCallback
1115 * @param {Uuid} entityID - The ID of the entity the event has occurred on.1115 * @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
1124 };1124 };
1125 };1125 };
1126 1126
1127 /**jsdoc1127 /*@jsdoc
1128 * Called when a collision event occurs on an entity as registered with {@link Script.addEventHandler}.1128 * Called when a collision event occurs on an entity as registered with {@link Script.addEventHandler}.
1129 * @callback Script~collisionEventCallback1129 * @callback Script~collisionEventCallback
1130 * @param {Uuid} entityA - The ID of one entity in the collision.1130 * @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
1139 };1139 };
1140 };1140 };
1141 1141
1142 /**jsdoc1142 /*@jsdoc
1143 * <p>The name of an entity event. When the entity event occurs, any function that has been registered for that event 1143 * <p>The name of an entity event. When the entity event occurs, any function that has been registered for that event
1144 * via {@link Script.addEventHandler} is called with parameters per the entity event.</p>1144 * via {@link Script.addEventHandler} is called with parameters per the entity event.</p>
1145 * <table>1145 * <table>
@@ -2349,7 +2349,7 @@ void ScriptEngine::loadEntityScript(const EntityItemID& entityID, const QString& · 1203 unmodified lines
2349 }, forceRedownload);2349 }, forceRedownload);
2350}2350}
2351 2351
2352/**jsdoc2352/*@jsdoc
2353 * Triggered when the script starts for a user. See also, {@link Script.entityScriptPreloadFinished}.2353 * Triggered when the script starts for a user. See also, {@link Script.entityScriptPreloadFinished}.
2354 * <p>Note: Can only be connected to via <code>this.preload = function (...) { ... }</code> in the entity script.</p>2354 * <p>Note: Can only be connected to via <code>this.preload = function (...) { ... }</code> in the entity script.</p>
2355 * <p class="availableIn"><strong>Supported Script Types:</strong> Client Entity Scripts &bull; Server Entity Scripts</p>2355 * <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
2636 emit entityScriptPreloadFinished(entityID);2636 emit entityScriptPreloadFinished(entityID);
2637}2637}
2638 2638
2639/**jsdoc2639/*@jsdoc
2640 * Triggered when the script terminates for a user.2640 * Triggered when the script terminates for a user.
2641 * <p>Note: Can only be connected to via <code>this.unoad = function () { ... }</code> in the entity script.</p>2641 * <p>Note: Can only be connected to via <code>this.unoad = function () { ... }</code> in the entity script.</p>
2642 * <p class="availableIn"><strong>Supported Script Types:</strong> Client Entity Scripts &bull; Server Entity Scripts</p>2642 * <p class="availableIn"><strong>Supported Script Types:</strong> Client Entity Scripts &bull; Server Entity Scripts</p>