History

Fix global print function's JSDoc

David Rowe committed 6 years ago

Commit bbd16d71 parent 5caa21e2 files · +7 −6Browse files

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

Unified · Split

libraries/script-engine/src/ScriptEngine.cpp+7−0
@@ -731,6 +731,13 @@ void ScriptEngine::init() { · 730 unmodified lines
731731 QScriptValue webSocketConstructorValue = newFunction(WebSocketClass::constructor);
732732 globalObject().setProperty("WebSocket", webSocketConstructorValue);
733733
734+ /**jsdoc
735+ * Prints a message to the program log and emits {@link Script.printedMessage}.
736+ * The message logged is the message values separated by spaces.
737+ * <p>Alternatively, you can use {@link Script.print} or one of the {@link console} API methods.</p>
738+ * @function print
739+ * @param {...*} [message] - The message values to print.
740+ */
734741 globalObject().setProperty("print", newFunction(debugPrint));
735742
736743 QScriptValue audioEffectOptionsConstructorValue = newFunction(AudioEffectOptions::constructor);