diff --git a/interface/src/ui/overlays/Overlays.h b/interface/src/ui/overlays/Overlays.h
index 0b2994b872..6eaf481efe 100644
--- a/interface/src/ui/overlays/Overlays.h
+++ b/interface/src/ui/overlays/Overlays.h
@@ -77,7 +77,7 @@ public:
* @hifi-avatar
*
* @property {Uuid} keyboardFocusOverlay - Get or set the {@link Entities.EntityTypes|Web} entity that has keyboard focus.
- * If no entity has keyboard focus, get returns null
; set to null
or {@link Uuid|Uuid.NULL} to
+ * If no entity has keyboard focus, get returns null
; set to null
or {@link Uuid(0)|Uuid.NULL} to
* clear keyboard focus.
*/
@@ -122,7 +122,7 @@ public slots:
* @function Overlays.addOverlay
* @param {Overlays.OverlayType} type - The type of the overlay to add.
* @param {Overlays.OverlayProperties} properties - The properties of the overlay to add.
- * @returns {Uuid} The ID of the newly created overlay if successful, otherwise {@link Uuid|Uuid.NULL}.
+ * @returns {Uuid} The ID of the newly created overlay if successful, otherwise {@link Uuid(0)|Uuid.NULL}.
* @example
null
or {@link Uuid|Uuid.NULL} to unset keyboard focus from an overlay.
+ * null
or {@link Uuid(0)|Uuid.NULL} to unset keyboard focus from an overlay.
*/
void setKeyboardFocusOverlay(const QUuid& id) { DependencyManager::getentityHostType
parameter in
* {@link Entities.addEntity}. Read-only.
* @property {Uuid} owningAvatarID=Uuid.NULL - The session ID of the owning avatar if avatarEntity
is
- * true
, otherwise {@link Uuid|Uuid.NULL}. Read-only.
+ * true
, otherwise {@link Uuid(0)|Uuid.NULL}. Read-only.
*
* @property {string} created - The UTC date and time that the entity was created, in ISO 8601 format as
* yyyy-MM-ddTHH:mm:ssZ
. Read-only.
@@ -728,7 +728,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* button beside the "script URL" field in properties tab of the Create app works.
* @property {string} serverScripts="" - The URL of the server entity script, if any, that is attached to the entity.
*
- * @property {Uuid} parentID=Uuid.NULL - The ID of the entity or avatar that this entity is parented to. {@link Uuid|Uuid.NULL}
+ * @property {Uuid} parentID=Uuid.NULL - The ID of the entity or avatar that this entity is parented to. {@link Uuid(0)|Uuid.NULL}
* if the entity is not parented.
* @property {number} parentJointIndex=65535 - The joint of the entity or avatar that this entity is parented to. Use
* 65535
or -1
to parent to the entity or avatar's position and orientation rather than a joint.
@@ -1174,17 +1174,17 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* @property {string} zTextureURL="" - URL of the texture to map to surfaces perpendicular to the entity's local z-axis. JPG or
* PNG format. If no texture is specified the surfaces display white.
* @property {Uuid} xNNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's -ve local x-axis direction,
- * if you want them joined. Set to {@link Uuid|Uuid.NULL} if there is none or you don't want to join them.
+ * if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
* @property {Uuid} yNNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's -ve local y-axis direction,
- * if you want them joined. Set to {@link Uuid|Uuid.NULL} if there is none or you don't want to join them.
+ * if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
* @property {Uuid} zNNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's -ve local z-axis direction,
- * if you want them joined. Set to {@link Uuid|Uuid.NULL} if there is none or you don't want to join them.
+ * if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
* @property {Uuid} xPNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's +ve local x-axis direction,
- * if you want them joined. Set to {@link Uuid|Uuid.NULL} if there is none or you don't want to join them.
+ * if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
* @property {Uuid} yPNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's +ve local y-axis direction,
- * if you want them joined. Set to {@link Uuid|Uuid.NULL} if there is none or you don't want to join them.
+ * if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
* @property {Uuid} zPNeighborID=Uuid.NULL - ID of the neighboring PolyVox entity in the entity's +ve local z-axis direction,
- * if you want them joined. Set to {@link Uuid|Uuid.NULL} if there is none or you don't want to join them.
+ * if you want them joined. Set to {@link Uuid(0)|Uuid.NULL} if there is none or you don't want to join them.
* @example null
; set to null
or {@link Uuid|Uuid.NULL} to
+ * If no entity has keyboard focus, get returns null
; set to null
or {@link Uuid(0)|Uuid.NULL} to
* clear keyboard focus.
*/
/// handles scripting of Entity commands from JS passed to assigned clients
@@ -267,7 +267,7 @@ public slots:
* follows you to each domain you visit, rendering at the same world coordinates unless it's parented to your avatar.
* If "local"
, the entity is created as a local entity, which will only render for you and isn't sent over the wire.
* Otherwise it is created as a normal entity and sent over the entity server.
- * @returns {Uuid} The ID of the entity if successfully created, otherwise {@link Uuid|Uuid.NULL}.
+ * @returns {Uuid} The ID of the entity if successfully created, otherwise {@link Uuid(0)|Uuid.NULL}.
* @example null
or {@link Uuid|Uuid.NULL} to unset keyboard focus from an entity.
+ * null
or {@link Uuid(0)|Uuid.NULL} to unset keyboard focus from an entity.
*/
Q_INVOKABLE void setKeyboardFocusEntity(const QUuid& id);
diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h
index 3cf5637c5f..8187c23f71 100644
--- a/libraries/networking/src/AddressManager.h
+++ b/libraries/networking/src/AddressManager.h
@@ -46,7 +46,7 @@ const QString GET_PLACE = "/api/v1/places/%1";
* @hifi-avatar
* @hifi-assignment-client
*
- * @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not
+ * @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid(0)|Uuid.NULL} if you're not
* connected to the domain or are in a serverless domain.
* Read-only.
* @property {string} hostname - The name of the domain for your current metaverse address (e.g., "AvatarIsland"
,
diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h
index e58609f01d..a2b16ed178 100644
--- a/libraries/script-engine/src/ScriptEngine.h
+++ b/libraries/script-engine/src/ScriptEngine.h
@@ -623,7 +623,7 @@ public:
/**jsdoc
* @function Script.generateUUID
* @returns {Uuid} A new UUID.
- * @deprecated This function is deprecated and will be removed. Use {@link Uuid.generate} instead.
+ * @deprecated This function is deprecated and will be removed. Use {@link Uuid(0).generate|Uuid.generate} instead.
*/
Q_INVOKABLE QUuid generateUUID() { return QUuid::createUuid(); }
diff --git a/libraries/script-engine/src/ScriptUUID.h b/libraries/script-engine/src/ScriptUUID.h
index 548bc6a6c8..4f0dfd10b6 100644
--- a/libraries/script-engine/src/ScriptUUID.h
+++ b/libraries/script-engine/src/ScriptUUID.h
@@ -19,11 +19,10 @@
#include {nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn}
, where the "n"s are
- * hexadecimal digits.
+ * The Uuid
API provides facilities for working with UUIDs.
*
* @namespace Uuid
+ * @variation 0
*
* @hifi-interface
* @hifi-client-entity
@@ -42,7 +41,7 @@ class ScriptUUID : public QObject, protected QScriptable {
public slots:
/**jsdoc
* Generates a UUID from a string representation of the UUID.
- * @function Uuid.fromString
+ * @function Uuid(0).fromString
* @param {string} string - A string representation of a UUID. The curly braces are optional.
* @returns {Uuid} A UUID if the given string
is valid, null
otherwise.
* @example true
if the two UUIDs are equal, otherwise false
.
@@ -94,7 +93,7 @@ public slots:
/**jsdoc
* Test whether a given UUID is null.
- * @function Uuid.isNull
+ * @function Uuid(0).isNull
* @param {Uuid} id - The UUID to test.
* @returns {boolean} true
if the UUID equals Uuid.NULL or is null
, otherwise false
.
* @example true
and false
cases."{nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn}"
, where the "n"s are
+ * hexadecimal digits.
+ * @typedef {string} Uuid
+ */
//Q_DECLARE_METATYPE(QUuid) // don't need to do this for QUuid since it's already a meta type
QScriptValue quuidToScriptValue(QScriptEngine* engine, const QUuid& uuid);
void quuidFromScriptValue(const QScriptValue& object, QUuid& uuid);