Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-05-30 18:50:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #12145 from ctrlaltdavid/21684

Browse source 
Update Window JSDoc per recent API changes
This commit is contained in:
MiladNazeri 2018-01-15 14:50:40 -08:00 committed by GitHub
commit c7cdf6b8f6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
interface/src/scripting/WindowScriptingInterface.h
View file

@ -42,7 +42,7 @@ void CustomPromptResultFromScriptValue(const QScriptValue& object, CustomPromptR
* @property {number} innerWidth - The width of the drawable area of the Interface window (i.e., without borders or other * @property {number} innerWidth - The width of the drawable area of the Interface window (i.e., without borders or other
* chrome), in pixels. <em>Read-only.</em> * chrome), in pixels. <em>Read-only.</em>
* @property {number} innerHeight - The height of the drawable area of the Interface window (i.e., without borders or other * @property {number} innerHeight - The height of the drawable area of the Interface window (i.e., without borders or other
* chrome) plus the height of the menu bar, in pixels. <em>Read-only.</em> * chrome), in pixels. <em>Read-only.</em>
* @property {object} location - Provides facilities for working with your current metaverse location. See {@link location}. * @property {object} location - Provides facilities for working with your current metaverse location. See {@link location}.
* @property {number} x - The x coordinate of the top left corner of the Interface window on the display. <em>Read-only.</em> * @property {number} x - The x coordinate of the top left corner of the Interface window on the display. <em>Read-only.</em>
* @property {number} y - The y coordinate of the top left corner of the Interface window on the display. <em>Read-only.</em> * @property {number} y - The y coordinate of the top left corner of the Interface window on the display. <em>Read-only.</em>
@ -301,7 +301,7 @@ public slots:
/**jsdoc /**jsdoc
* Get Interface's build number. * Get Interface's build number.
* @function Window.checkVersion * @function Window.checkVersion
* @returns {string} - Interface's build number. * @returns {string} Interface's build number.
*/ */
QString checkVersion(); QString checkVersion();
@ -327,7 +327,7 @@ public slots:
* full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of 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. * dimensions is adjusted in order to match the aspect ratio.
* @example <caption>Using the snapshot function and signals.</caption> * @example <caption>Using the snapshot function and signals.</caption>
* function onStillSnapshottaken(path, notify) { * function onStillSnapshotTaken(path, notify) {
* print("Still snapshot taken: " + path); * print("Still snapshot taken: " + path);
* print("Notify: " + notify); * print("Notify: " + notify);
* } * }
@ -340,7 +340,7 @@ public slots:
* print("Animated snapshot taken: " + animatedPath); * print("Animated snapshot taken: " + animatedPath);
* } * }
* *
* Window.stillSnapshotTaken.connect(onStillSnapshottaken); * Window.stillSnapshotTaken.connect(onStillSnapshotTaken);
* Window.processingGifStarted.connect(onProcessingGifStarted); * Window.processingGifStarted.connect(onProcessingGifStarted);
* Window.processingGifCompleted.connect(onProcessingGifCompleted); * Window.processingGifCompleted.connect(onProcessingGifCompleted);
* *
@ -555,7 +555,7 @@ signals:
/**jsdoc /**jsdoc
* Triggered when a still snapshot has been taken by calling {@link Window.takeSnapshot|takeSnapshot} with * Triggered when a still snapshot has been taken by calling {@link Window.takeSnapshot|takeSnapshot} with
* <code>includeAnimated = false</code>. * <code>includeAnimated = false</code> or {@link Window.takeSecondaryCameraSnapshot|takeSecondaryCameraSnapshot}.
* @function Window.stillSnapshotTaken * @function Window.stillSnapshotTaken
* @param {string} pathStillSnapshot - The path and name of the snapshot image file. * @param {string} pathStillSnapshot - The path and name of the snapshot image file.
* @param {boolean} notify - The value of the <code>notify</code> parameter that {@link Window.takeSnapshot|takeSnapshot} * @param {boolean} notify - The value of the <code>notify</code> parameter that {@link Window.takeSnapshot|takeSnapshot}