History

Update some recent JSDoc additions

David Rowe committed 8 years ago

Commit fa544611 parent e44e7ca2 files · +10 −5Browse files

Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 2 files). Show all

Unified · Split

interface/src/scripting/WindowScriptingInterface.h+9−4
@@ -523,16 +523,21 @@ public slots: · 522 unmodified lines
523 int openMessageBox(QString title, QString text, int buttons, int defaultButton);523 int openMessageBox(QString title, QString text, int buttons, int defaultButton);
524 524
525 /**jsdoc525 /**jsdoc
526 * Open the given resource in the Interface window or in a web browser depending on the url scheme526 * Open a URL in the Interface window or other application, depending on the URL's scheme. If the URL starts with
527 * <code>hifi://</code> then that URL is navigated to in Interface, otherwise the URL is opened in the application the OS
528 * associates with the URL's scheme (e.g., a Web browser for <code>http://</code>).
527 * @function Window.openUrl529 * @function Window.openUrl
528 * @param {string} url - The resource to open530 * @param {string} url - The URL to open.
529 */531 */
530 void openUrl(const QUrl& url);532 void openUrl(const QUrl& url);
531 533
532 /**jsdoc534 /**jsdoc
533 * (Android only) Open the requested Activity and optionally back to the scene when the activity is done535 * Open an Android activity and optionally return back to the scene when the activity is completed. <em>Android only.</em>
534 * @function Window.openAndroidActivity536 * @function Window.openAndroidActivity
535 * @param {string} activityName - The name of the activity to open. One of "Home", "Login" or "Privacy Policy"537 * @param {string} activityName - The name of the activity to open: one of <code>"Home"</code>, <code>"Login"</code>, or
538 * <code>"Privacy Policy"</code>.
539 * @param {boolean} backToScene - If <code>true</code>, the user is automatically returned back to the scene when the
540 * activity is completed.
536 */541 */
537 void openAndroidActivity(const QString& activityName, const bool backToScene);542 void openAndroidActivity(const QString& activityName, const bool backToScene);
538 543

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t