Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-08 10:37:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1278 from ctrlaltdavid/fix/addressmanager-jsdoc

Browse source 
Misc fixes to AddressManager JSDoc
This commit is contained in:
Kalila 2021-07-05 17:02:20 -04:00 committed by GitHub
commit cdd2341880
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
libraries/networking/src/AddressManager.h
View file

@ -252,8 +252,8 @@ public slots:
* <code>"127.0.0.1"</code> or <code>"localhost"</code>), a <code>file:///</code> address, a domain name, a named path * <code>"127.0.0.1"</code> or <code>"localhost"</code>), a <code>file:///</code> address, a domain name, a named path
* on a domain (starts with <code>"/"</code>), a position or position and orientation, or a user (starts with * on a domain (starts with <code>"/"</code>), a position or position and orientation, or a user (starts with
* <code>"@"</code>). * <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 "Explore" app.
* Helps ensure that user's location history is correctly maintained. * Helps ensure that the user's location history is correctly maintained.
*/ */
void handleLookupString(const QString& lookupString, bool fromSuggestions = false); void handleLookupString(const QString& lookupString, bool fromSuggestions = false);
@ -390,10 +390,10 @@ signals:
void lookupResultIsNotFound(); void lookupResultIsNotFound();
/*@jsdoc /*@jsdoc
* Triggered when a request is made to go to an IP address. * Triggered when a request is made to go to a URL or IP address.
* @function location.possibleDomainChangeRequired * @function location.possibleDomainChangeRequired
* @param {Url} domainURL - URL for domain * @param {string} domainURL - The URL of the domain.
* @param {Uuid} domainID - The UUID of the domain to go to. * @param {Uuid} domainID - The UUID of the domain to go to. May be {@link Uuid|Uuid.NULL} if not yet known.
* @returns {Signal} * @returns {Signal}
*/ */
// No example because this function isn't typically used in scripts. // No example because this function isn't typically used in scripts.