diff --git a/interface/src/raypick/PickScriptingInterface.h b/interface/src/raypick/PickScriptingInterface.h index 288d3008bb..f2cd9287a5 100644 --- a/interface/src/raypick/PickScriptingInterface.h +++ b/interface/src/raypick/PickScriptingInterface.h @@ -109,7 +109,7 @@ public: * * @typedef {Object} Picks.RayPickResult * @property {number} type The intersection type. - * @property {bool} intersects If there was a valid intersection (type != INTERSECTED_NONE) + * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE) * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. * @property {float} distance The distance to the intersection point from the origin of the ray. * @property {Vec3} intersection The intersection point in world-space. @@ -123,7 +123,7 @@ public: * * @typedef {Object} Picks.StylusPickResult * @property {number} type The intersection type. - * @property {bool} intersects If there was a valid intersection (type != INTERSECTED_NONE) + * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE) * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. * @property {float} distance The distance to the intersection point from the origin of the ray. * @property {Vec3} intersection The intersection point in world-space. diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h index 8a8dc61ba8..0b766d2097 100644 --- a/interface/src/scripting/WindowScriptingInterface.h +++ b/interface/src/scripting/WindowScriptingInterface.h @@ -87,7 +87,7 @@ public slots: * Display a dialog with the specified message and an "OK" button. The dialog is non-modal; the script continues without * waiting for a user response. * @function Window.alert - * @param {string} message="" - The message to display. + * @param {string} [message=""] - The message to display. * @example
true
if the user selects "Yes", otherwise false
.
* @example null
.
* @example "*.json"
and
+ * @param {string} [title=""] - The title to display at the top of the dialog.
+ * @param {string} [directory=""] - The initial directory to start browsing at.
+ * @param {string} [nameFilter=""] - The types of files to display. Examples: "*.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 if one is chosen, otherwise null
.
* @example "*.json"
and
+ * @param {string} [title=""] - The title to display at the top of the dialog.
+ * @param {string} [directory=""] - The initial directory to start browsing at.
+ * @param {string} [nameFilter=""] - The types of files to display. Examples: "*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @example "*.json"
and
+ * @param {string} [title=""] - The title to display at the top of the dialog.
+ * @param {string} [directory=""] - The initial directory to start browsing at.
+ * @param {string} [nameFilter=""] - The types of files to display. Examples: "*.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 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.
@@ -226,9 +226,9 @@ public slots:
* directory tree and allows the user to type in a file name. A {@link Window.saveFileChanged|saveFileChanged} signal is
* emitted when a file is specified; no signal is emitted if the user cancels the dialog.
* @function Window.saveAsync
- * @param {string} title="" - The title to display at the top of the dialog.
- * @param {string} directory="" - The initial directory to start browsing at.
- * @param {string} nameFilter="" - The types of files to display. Examples: "*.json"
and
+ * @param {string} [title=""] - The title to display at the top of the dialog.
+ * @param {string} [directory=""] - The initial directory to start browsing at.
+ * @param {string} [nameFilter=""] - The types of files to display. Examples: "*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @example "*.json"
and
+ * @param {string} [title=""] - The title to display at the top of the dialog.
+ * @param {string} [directory=""] - The initial directory to start browsing at.
+ * @param {string} [nameFilter=""] - The types of files to display. Examples: "*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @returns {string} The path and name of the asset if one is chosen, otherwise null
.
* @example "*.json"
and
+ * @param {string} [title=""] - The title to display at the top of the dialog.
+ * @param {string} [directory=""] - The initial directory to start browsing at.
+ * @param {string} [nameFilter=""] - The types of files to display. Examples: "*.json"
and
* "Images (*.png *.jpg *.svg)"
. All files are displayed if a filter isn't specified.
* @example
* function onAssetsDirChanged(asset) {
@@ -280,7 +280,7 @@ public slots:
* Open the Asset Browser dialog. If a file to upload is specified, the user is prompted to enter the folder and name to
* map the file to on the asset server.
* @function Window.showAssetServer
- * @param {string} uploadFile="" - The path and name of a file to upload to the asset server.
+ * @param {string} [uploadFile=""] - The path and name of a file to upload to the asset server.
* @example true
, a moving image is captured as an animated GIF in addition
+ * @param {boolean} [includeAnimated=false] - If 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
+ * @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 of the
* dimensions is adjusted in order to match the aspect ratio.
- * @param {string} filename="" - If this parameter is not given, the image will be saved as 'hifi-snap-by-""
then the image will be saved as ".jpg".
* Otherwise, the image will be saved to this filename, with an appended ".jpg".
*
@@ -358,7 +358,7 @@ public slots:
* Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API.
* NOTE: to provide a non-default value - all previous parameters must be provided.
* @function Window.takeSecondaryCameraSnapshot
- * @param {string} filename="" - If this parameter is not given, the image will be saved as 'hifi-snap-by-""
then the image will be saved as ".jpg".
* Otherwise, the image will be saved to this filename, with an appended ".jpg".
*
@@ -397,7 +397,7 @@ public slots:
* has been prepared.
* @function Window.shareSnapshot
* @param {string} path - The path and name of the image file to share.
- * @param {string} href="" - The metaverse location where the snapshot was taken.
+ * @param {string} [href=""] - The metaverse location where the snapshot was taken.
*/
void shareSnapshot(const QString& path, const QUrl& href = QUrl(""));