From cf9e563458642c6a72cdfb4903924ed2202c038a Mon Sep 17 00:00:00 2001 From: David Rowe Date: Fri, 19 Jul 2019 08:37:10 +1200 Subject: [PATCH] Miscellaneous JSDoc fixes noticed in passing --- interface/src/avatar/AvatarManager.h | 2 +- interface/src/avatar/MyAvatar.h | 4 ++-- libraries/avatars/src/AvatarData.cpp | 2 +- libraries/avatars/src/AvatarData.h | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h index ce23a80309..30f68297b4 100644 --- a/interface/src/avatar/AvatarManager.h +++ b/interface/src/avatar/AvatarManager.h @@ -238,7 +238,7 @@ public: * @function AvatarManager.getPalData * @param {string[]} [avatarIDs=[]] - The IDs of the avatars to get the PAL data for. If empty, then PAL data is obtained * for all avatars. - * @returns {object<"data", AvatarManager.PalData[]>} An array of objects, each object being the PAL data for an avatar. + * @returns {Object<"data", AvatarManager.PalData[]>} An array of objects, each object being the PAL data for an avatar. * @example Report the PAL data for an avatar nearby. * var palData = AvatarManager.getPalData(); * print("PAL data for one avatar: " + JSON.stringify(palData.data[0])); diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h index d092122863..62605a5bee 100644 --- a/interface/src/avatar/MyAvatar.h +++ b/interface/src/avatar/MyAvatar.h @@ -1369,9 +1369,9 @@ public: bool hasDriveInput() const; /**jsdoc - * Gets the list of avatar entities and their properties. + * Gets the current avatar entity IDs and their properties. * @function MyAvatar.getAvatarEntitiesVariant - * @returns {MyAvatar.AvatarEntityData[]} The list of avatar entities and their properties. + * @returns {MyAvatar.AvatarEntityData[]} The current avatar entity IDs and their properties. */ Q_INVOKABLE QVariantList getAvatarEntitiesVariant(); diff --git a/libraries/avatars/src/AvatarData.cpp b/libraries/avatars/src/AvatarData.cpp index a2dde3d651..22b070464d 100755 --- a/libraries/avatars/src/AvatarData.cpp +++ b/libraries/avatars/src/AvatarData.cpp @@ -2861,7 +2861,7 @@ glm::vec3 AvatarData::getAbsoluteJointTranslationInObjectFrame(int index) const * Information on an attachment worn by the avatar. * @typedef {object} AttachmentData * @property {string} modelUrl - The URL of the model file. Models can be FBX or OBJ format. - * @property {string} jointName - The offset to apply to the model relative to the joint position. + * @property {string} jointName - The name of the joint that the attachment is parented to. * @property {Vec3} translation - The offset from the joint that the attachment is positioned at. * @property {Vec3} rotation - The rotation applied to the model relative to the joint orientation. * @property {number} scale - The scale applied to the attachment model. diff --git a/libraries/avatars/src/AvatarData.h b/libraries/avatars/src/AvatarData.h index 498f39cdf9..3c8e2d6fcc 100755 --- a/libraries/avatars/src/AvatarData.h +++ b/libraries/avatars/src/AvatarData.h @@ -1292,7 +1292,7 @@ public: * jointName: "Head", * translation: {"x": 0, "y": 0.25, "z": 0}, * rotation: {"x": 0, "y": 0, "z": 0, "w": 1}, - * scale: 1, + * scale: 0.01, * isSoft: false * }; *