From d5bb7f25e1b740c6ea4ece90a926f6c48918d887 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 15 May 2019 07:56:55 +1200 Subject: [PATCH] Doc review --- .../src/scripting/DesktopScriptingInterface.h | 4 ++-- .../scripting/PlatformInfoScriptingInterface.h | 2 +- interface/src/ui/InteractiveWindow.h | 10 +++++----- .../src/material-networking/TextureCache.cpp | 2 +- libraries/networking/src/AddressManager.h | 17 +++++++++-------- 5 files changed, 18 insertions(+), 17 deletions(-) diff --git a/interface/src/scripting/DesktopScriptingInterface.h b/interface/src/scripting/DesktopScriptingInterface.h index 5cd264606e..b4ff159176 100644 --- a/interface/src/scripting/DesktopScriptingInterface.h +++ b/interface/src/scripting/DesktopScriptingInterface.h @@ -65,7 +65,7 @@ public: * Opens a QML window within Interface: in the Interface window in desktop mode or on the HUD surface in HMD mode. If a * window of the specified name already exists, it is shown, otherwise a new window is created from the QML. * @function Desktop.show - * @param {string} url - The QML file that specifies the window content + * @param {string} url - The QML file that specifies the window content. * @param {string} name - A unique name for the window. * @example Open the general settings dialog. * Desktop.show("hifi/dialogs/GeneralPreferencesDialog.qml", "GeneralPreferencesDialog"); @@ -76,7 +76,7 @@ public: * Creates a new window that can be displayed either within Interface or as a separate desktop window. * @function Desktop.createWindow * @param {string} url - The QML file that specifies the window content. The QML file can use a WebView - * control (defined by "WebView.qml" included in the Interface install) to embed an HTML Web page (complete with + * control (defined by "WebView.qml" included in the Interface install) to embed an HTML web page (complete with * EventBridge object). * @param {InteractiveWindow.Properties} [properties] - Initial window properties. * @returns {InteractiveWindow} A new window object. diff --git a/interface/src/scripting/PlatformInfoScriptingInterface.h b/interface/src/scripting/PlatformInfoScriptingInterface.h index f4d91d1230..c065f849f2 100644 --- a/interface/src/scripting/PlatformInfoScriptingInterface.h +++ b/interface/src/scripting/PlatformInfoScriptingInterface.h @@ -59,7 +59,7 @@ public slots: /**jsdoc * Returns the total system memory in megabytes. * @function PlatformInfo.getTotalSystemMemoryMB - * @returns {number} the total system memory in megabytes. + * @returns {number} The total system memory in megabytes. */ int getTotalSystemMemoryMB(); diff --git a/interface/src/ui/InteractiveWindow.h b/interface/src/ui/InteractiveWindow.h index a691e692e8..22127479d2 100644 --- a/interface/src/ui/InteractiveWindow.h +++ b/interface/src/ui/InteractiveWindow.h @@ -66,7 +66,7 @@ using namespace InteractiveWindowEnums; /**jsdoc * An InteractiveWindow can display either inside Interface or in its own window separate from the Interface * window. The window content is defined by a QML file, which can optionally include a WebView control that embeds - * an HTML Web page. (The WebView control is defined by a "WebView.qml" file included in the Interface install.) + * an HTML web page. (The WebView control is defined by a "WebView.qml" file included in the Interface install.) * *

Create using {@link Desktop.createWindow}.

* @@ -170,13 +170,13 @@ public slots: void sendToQml(const QVariant& message); /**jsdoc - * Sends a message to an embedded HTML Web page. To receive the message, the HTML page's script must connect to the + * Sends a message to an embedded HTML web page. To receive the message, the HTML page's script must connect to the * EventBridge that is automatically provided to the script: * 
EventBridge.scriptEventReceived.connect(function(message) {
      *     ...
      * });
* @function InteractiveWindow.emitScriptEvent - * @param {string|object} message - The message to send to the embedded HTML Web page. + * @param {string|object} message - The message to send to the embedded HTML web page. */ // QmlWindow content may include WebView requiring EventBridge. void emitScriptEvent(const QVariant& scriptMessage); @@ -223,7 +223,7 @@ signals: void positionChanged(); /**jsdoc - * Triggered when the window's' size changes. + * Triggered when the window's size changes. * @function InteractiveWindow.sizeChanged * @returns {Signal} */ @@ -270,7 +270,7 @@ signals: void scriptEventReceived(const QVariant& message); /**jsdoc - * Trigged when a message from an embedded HTML Web page is received. The HTML Web page can send a message by calling: + * Triggered when a message from an embedded HTML web page is received. The HTML web page can send a message by calling: * 
EventBridge.emitWebEvent(message);
* @function InteractiveWindow.webEventReceived * @param {string|object} message - The message received. diff --git a/libraries/material-networking/src/material-networking/TextureCache.cpp b/libraries/material-networking/src/material-networking/TextureCache.cpp index d8ad362de1..8ffcad0c69 100644 --- a/libraries/material-networking/src/material-networking/TextureCache.cpp +++ b/libraries/material-networking/src/material-networking/TextureCache.cpp @@ -65,7 +65,7 @@ const std::string TextureCache::KTX_DIRNAME{ "ktx_cache" }; const std::string TextureCache::KTX_EXT { "ktx" }; /**jsdoc - *

The views that may be displayed on the PC display.

+ *

The views that may be visible on the PC display.

* * * diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h index 48a245538d..3cf5637c5f 100644 --- a/libraries/networking/src/AddressManager.h +++ b/libraries/networking/src/AddressManager.h @@ -245,21 +245,22 @@ public slots: * Takes you to the specified user's location. * @function location.goToUser * @param {string} username - The user's username. - * @param {boolean} [matchOrientation=true] - If true then go to a location just in front of the user and turn to face - * them, otherwise go to the user's exact location and orientation. + * @param {boolean} [matchOrientation=true] - If true then go to a location just in front of the user and turn + * to face them, otherwise go to the user's exact location and orientation. */ void goToUser(const QString& username, bool shouldMatchOrientation = true); /**jsdoc - * Takes you to the last address tried. This will be the last URL tried from location.handleLookupString - * @function location.goToLastAddress - */ + * Takes you to the last address tried. This will be the last URL tried from location.handleLookupString. + * @function location.goToLastAddress + */ void goToLastAddress() { handleUrl(_lastVisitedURL, LookupTrigger::AttemptedRefresh); } /**jsdoc - * Checks if going back is possible. - * @function location.canGoBack - */ + * Checks if going back to the previous location is possible. + * @function location.canGoBack + * @returns true if going back is possible, false if it isn't. + */ bool canGoBack() const; /**jsdoc