Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-08 03:48:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc review

Browse source
This commit is contained in:
David Rowe 2018-01-16 17:14:30 +13:00
parent f319fa70cb
commit 02179e3efd
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
libraries/networking/src/AddressManager.h
View file

@ -183,6 +183,7 @@ public slots:
* <code>"127.0.0.1"</code> or <code>"localhost"</code>), a domain name, a named path on a domain (starts with * <code>"127.0.0.1"</code> or <code>"localhost"</code>), a domain name, a named path on a domain (starts with
* <code>"/"</code>), a position or position and orientation, or a user (starts with <code>"@"</code>). * <code>"/"</code>), a position or position and orientation, or a user (starts with <code>"@"</code>).
* @param {boolean} fromSuggestions=false - Set to <code>true</code> if the address is obtained from the "Goto" dialog. * @param {boolean} fromSuggestions=false - Set to <code>true</code> if the address is obtained from the "Goto" dialog.
* Helps ensure that user's location history is correctly maintained.
*/ */
void handleLookupString(const QString& lookupString, bool fromSuggestions = false); void handleLookupString(const QString& lookupString, bool fromSuggestions = false);
@ -217,14 +218,16 @@ public slots:
* Go to the local Sandbox server that's running on the same PC as Interface. * Go to the local Sandbox server that's running on the same PC as Interface.
* @function location.goToLocalSandbox * @function location.goToLocalSandbox
* @param {string} path="" - The position and orientation to go to (e.g., <code>"/0,0,0"</code>). * @param {string} path="" - The position and orientation to go to (e.g., <code>"/0,0,0"</code>).
* @param {location.LookupTrigger} trigger=StartupFromSettings - The reason for the function call. * @param {location.LookupTrigger} trigger=StartupFromSettings - The reason for the function call. Helps ensure that user's
* location history is correctly maintained.
*/ */
void goToLocalSandbox(QString path = "", LookupTrigger trigger = LookupTrigger::StartupFromSettings) { handleUrl(SANDBOX_HIFI_ADDRESS + path, trigger); } void goToLocalSandbox(QString path = "", LookupTrigger trigger = LookupTrigger::StartupFromSettings) { handleUrl(SANDBOX_HIFI_ADDRESS + path, trigger); }
/**jsdoc /**jsdoc
* Go to the default metaverse address. * Go to the default "welcome" metaverse address.
* @function location.goToEntry * @function location.goToEntry
* @param {location.LookupTrigger} trigger=StartupFromSettings - The reason for the function call. * @param {location.LookupTrigger} trigger=StartupFromSettings - The reason for the function call. Helps ensure that user's
* location history is correctly maintained.
*/ */
void goToEntry(LookupTrigger trigger = LookupTrigger::StartupFromSettings) { handleUrl(DEFAULT_HIFI_ADDRESS, trigger); } void goToEntry(LookupTrigger trigger = LookupTrigger::StartupFromSettings) { handleUrl(DEFAULT_HIFI_ADDRESS, trigger); }
@ -238,7 +241,7 @@ public slots:
void goToUser(const QString& username, bool shouldMatchOrientation = true); void goToUser(const QString& username, bool shouldMatchOrientation = true);
/**jsdoc /**jsdoc
* Refresh the current address, e.g., after connecting to a domain ion order to position the user to the desired location. * Refresh the current address, e.g., after connecting to a domain in order to position the user to the desired location.
* @function location.refreshPreviousLookup * @function location.refreshPreviousLookup
* @deprecated This function is deprecated and will be removed. * @deprecated This function is deprecated and will be removed.
*/ */
@ -247,7 +250,8 @@ public slots:
void refreshPreviousLookup(); void refreshPreviousLookup();
/**jsdoc /**jsdoc
* Save your current metaverse location in Interface's settings file. * Update your current metaverse location in Interface's {@link Settings} file as your last-know address. This can be used
* to ensure that you start up at that address if you exit Interface without a later address automatically being saved.
* @function location.storeCurrentAddress * @function location.storeCurrentAddress
*/ */
void storeCurrentAddress(); void storeCurrentAddress();