diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h
index 09938f0549..c2fab67951 100644
--- a/interface/src/scripting/WindowScriptingInterface.h
+++ b/interface/src/scripting/WindowScriptingInterface.h
@@ -34,7 +34,9 @@ void CustomPromptResultFromScriptValue(const QScriptValue& object, CustomPromptR
/**jsdoc
- * The Window API provides various facilities not covered elsewhere.
+ * The Window API provides various facilities not covered elsewhere: window dimensions, window focus, normal or entity camera
+ * view, clipboard, announcements, user connections, common dialog boxes, snapshots, file import, domain changes, domain
+ * physics.
*
* @namespace Window
* @property {number} innerWidth - The width of the drawable area of the Interface window (i.e., without borders or other
@@ -187,8 +189,8 @@ public slots:
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @returns {string} The path and name of the file if one is chosen, otherwise null
.
* @example
"*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @example "*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
- * @returns {string} The path and name of the file is one is specified, otherwise null
. If a single file type
+ * @returns {string} The path and name of the file if one is specified, otherwise null
. If a single file type
* is specified in the nameFilter, that file type extension is automatically appended to the result when appropriate.
* @example "*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @example true
, a moving image is captured as an animated GIF in addition
* to a still image.
* @param {number} aspectRatio=0 - The width/height ratio of the snapshot required. If the value is 0
the
- * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one or
- * other dimension is adjusted in order to match the aspect ratio.
+ * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the
+ * dimensions is adjusted in order to match the aspect ratio.
* @example true
then {@link Window.connectionAdded|connectionAdded} is emitted, otherwise
* {@link Window.connectionError|connectionError} is emitted.
@@ -416,7 +418,7 @@ public slots:
* Set what to show on the PC display: normal view or entity camera view. The entity camera is configured using
* {@link Camera.setCameraEntity} and {@link Camera|Camera.mode}.
* @function Window.setDisplayTexture
- * @param {Window.DisplayTexture} name - The view to display.
+ * @param {Window.DisplayTexture} texture - The view to display.
* @returns {boolean} true
if the display texture was successfully set, otherwise false
.
*/
// See spectatorCamera.js for Valid parameter values.
@@ -445,17 +447,18 @@ public slots:
bool setDisplayTexture(const QString& name);
/**jsdoc
- * Check if a 2D point is within the drawable area of the HUD overlay.
+ * Check if a 2D point is within the desktop window if in desktop mode, or the drawable area of the HUD overlay if in HMD
+ * mode.
* @function Window.isPointOnDesktopWindow
- * @param {Vec2} point - The point to check in HMD display coordinates.
+ * @param {Vec2} point - The point to check.
* @returns {boolean} true
if the point is within the window or HUD, otherwise false
.
*/
bool isPointOnDesktopWindow(QVariant point);
/**jsdoc
- * Get the size of the drawable area of the Interface window if in desktop mode or the HMD display if in HMD mode.
+ * Get the size of the drawable area of the Interface window if in desktop mode or the HMD rendering surface if in HMD mode.
* @function Window.getDeviceSize
- * @returns {Vec2} The width and height of the Interface window or HMD display, in pixels.
+ * @returns {Vec2} The width and height of the Interface window or HMD rendering surface, in pixels.
*/
glm::vec2 getDeviceSize() const;
@@ -521,13 +524,19 @@ signals:
* @function Window.domainChanged
* @param {string} domain - The domain's IP address.
* @returns {Signal}
+ * @example includeAnimated = false
.
* @function Window.stillSnapshotTaken
* @param {string} pathStillSnapshot - The path and name of the snapshot image file.
@@ -611,7 +620,7 @@ signals:
* Triggered when the user closes a message box that was opened with {@link Window.openMessageBox|openMessageBox}.
* @function Window.messageBoxClosed
* @param {number} id - The ID of the message box that was closed.
- * @param {number} button - The button that the user clicked. If the user presses Esc the Cancel button value is returned,
+ * @param {number} button - The button that the user clicked. If the user presses Esc, the Cancel button value is returned,
* whether or not the Cancel button is displayed in the message box.
* @returns {Signal}
*/