From bbd16d7544166ef4fb3fd51a49d3d807ed5e76d4 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 11 Dec 2019 07:42:58 +1300 Subject: [PATCH] Fix global print function's JSDoc --- libraries/script-engine/src/ScriptEngine.cpp | 7 +++++++ libraries/script-engine/src/ScriptEngine.h | 6 ------ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp index 4cf4a9fc42..7e3f556c2d 100644 --- a/libraries/script-engine/src/ScriptEngine.cpp +++ b/libraries/script-engine/src/ScriptEngine.cpp @@ -731,6 +731,13 @@ void ScriptEngine::init() { QScriptValue webSocketConstructorValue = newFunction(WebSocketClass::constructor); globalObject().setProperty("WebSocket", webSocketConstructorValue); + /**jsdoc + * Prints a message to the program log and emits {@link Script.printedMessage}. + * The message logged is the message values separated by spaces. + *

Alternatively, you can use {@link Script.print} or one of the {@link console} API methods.

+ * @function print + * @param {...*} [message] - The message values to print. + */ globalObject().setProperty("print", newFunction(debugPrint)); QScriptValue audioEffectOptionsConstructorValue = newFunction(AudioEffectOptions::constructor); diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index 404ac1ae41..3891f60d92 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -504,12 +504,6 @@ public: * @function Script.print * @param {string} message - The message to print. */ - /**jsdoc - * Prints a message to the program log. - *

This is an alias of {@link Script.print}.

- * @function print - * @param {string} message - The message to print. - */ Q_INVOKABLE void print(const QString& message); /**jsdoc