From fa54461788d592ff96567fa4aa8025eb5b1b813a Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 22 May 2018 08:52:39 +1200 Subject: [PATCH] Update some recent JSDoc additions --- interface/src/scripting/WindowScriptingInterface.h | 13 +++++++++---- libraries/networking/src/AddressManager.h | 2 +- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h index d280d797d6..5ddbc30dd3 100644 --- a/interface/src/scripting/WindowScriptingInterface.h +++ b/interface/src/scripting/WindowScriptingInterface.h @@ -523,16 +523,21 @@ public slots: int openMessageBox(QString title, QString text, int buttons, int defaultButton); /**jsdoc - * Open the given resource in the Interface window or in a web browser depending on the url scheme + * Open a URL in the Interface window or other application, depending on the URL's scheme. If the URL starts with + * hifi:// then that URL is navigated to in Interface, otherwise the URL is opened in the application the OS + * associates with the URL's scheme (e.g., a Web browser for http://). * @function Window.openUrl - * @param {string} url - The resource to open + * @param {string} url - The URL to open. */ void openUrl(const QUrl& url); /**jsdoc - * (Android only) Open the requested Activity and optionally back to the scene when the activity is done + * Open an Android activity and optionally return back to the scene when the activity is completed. Android only. * @function Window.openAndroidActivity - * @param {string} activityName - The name of the activity to open. One of "Home", "Login" or "Privacy Policy" + * @param {string} activityName - The name of the activity to open: one of "Home", "Login", or + * "Privacy Policy". + * @param {boolean} backToScene - If true, the user is automatically returned back to the scene when the + * activity is completed. */ void openAndroidActivity(const QString& activityName, const bool backToScene); diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h index a12a18fa6a..38eb7ee670 100644 --- a/libraries/networking/src/AddressManager.h +++ b/libraries/networking/src/AddressManager.h @@ -184,7 +184,7 @@ public slots: /**jsdoc * Go to a specified metaverse address. * @function location.handleLookupString - * @param {string} address - The address to go to: a "hifi:/" address, an IP address (e.g., + * @param {string} address - The address to go to: a "hifi://" address, an IP address (e.g., * "127.0.0.1" or "localhost"), a domain name, a named path on a domain (starts with * "/"), a position or position and orientation, or a user (starts with "@"). * @param {boolean} fromSuggestions=false - Set to true if the address is obtained from the "Goto" dialog.