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

Merge pull request #13102 from ctrlaltdavid/21856-h

Browse source 
Fix JSDoc for Users.requestUsernameFromID
This commit is contained in:
MiladNazeri 2018-05-09 13:35:06 -07:00 committed by GitHub
commit bc03fb398f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
libraries/script-engine/src/UsersScriptingInterface.h
View file

@ -106,9 +106,10 @@ public slots:
void mute(const QUuid& nodeID); void mute(const QUuid& nodeID);
/**jsdoc /**jsdoc
* Get the user name and machine fingerprint associated with the given UUID. This will only do anything if you're an admin * Request the user name and machine fingerprint associated with the given UUID. The user name will be returned in a
* of the domain you're in. * {@link Users.usernameFromIDReply|usernameFromIDReply} signal. This will only do anything if you're an admin of the domain
* @function Users.getUsernameFromID * you're in.
* @function Users.requestUsernameFromID
* @param {Uuid} nodeID The node or session ID of the user whose user name you want. * @param {Uuid} nodeID The node or session ID of the user whose user name you want.
*/ */
void requestUsernameFromID(const QUuid& nodeID); void requestUsernameFromID(const QUuid& nodeID);
@ -170,7 +171,8 @@ signals:
void enteredIgnoreRadius(); void enteredIgnoreRadius();
/**jsdoc /**jsdoc
* Notifies scripts of the user name and machine fingerprint associated with a UUID. * Triggered in response to a {@link Users.requestUsernameFromID|requestUsernameFromID} call. Provides the user name and
* machine fingerprint associated with a UUID.
* Username and machineFingerprint will be their default constructor output if the requesting user isn't an admin. * Username and machineFingerprint will be their default constructor output if the requesting user isn't an admin.
* @function Users.usernameFromIDReply * @function Users.usernameFromIDReply
* @param {Uuid} nodeID * @param {Uuid} nodeID