Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix JSDoc for Users.requestUsernameFromID

Browse source
This commit is contained in:
David Rowe 2018-05-05 07:05:10 +12:00
parent c7bc479c60
commit a35517d985
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -106,10 +106,11 @@ 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.
* @param {Uuid} nodeID The node or session ID of the user whose username you want. * @function Users.requestUsernameFromID
* @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