From c86ef990db07230645fa0f4fe07bf93ed71db54e Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 18 Dec 2019 07:27:53 +1300 Subject: [PATCH] Fix up JSDoc for Window.minimizedChanged signal --- interface/src/scripting/WindowScriptingInterface.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h index f3e9dea45f..bf39073db1 100644 --- a/interface/src/scripting/WindowScriptingInterface.h +++ b/interface/src/scripting/WindowScriptingInterface.h @@ -818,8 +818,12 @@ signals: /**jsdoc * Triggered when "minimized" state of the Interface window changes. * @function Window.minimizedChanged - * @param {bool} isMinimized - true if the Interface window is now minimized; false otherwise. + * @param {boolean} isMinimized - true if the Interface window is minimized, false if it isn't. * @returns {Signal} + * @example Report the "minimized" state of the Interface window when it changes. + * function onWindowMinimizedChanged(minimized) { + * print("Window minimized: " + minimized); + * } * * Window.minimizedChanged.connect(onWindowMinimizedChanged); */