From 38e21dcaa20b08819911d8d424bd8fa0733e28b5 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Thu, 11 Apr 2019 11:04:02 +1200 Subject: [PATCH] Doc review --- interface/src/avatar/AvatarManager.h | 16 ++++++++-------- libraries/avatars/src/AvatarHashMap.h | 2 +- libraries/avatars/src/ScriptAvatarData.h | 2 +- libraries/render-utils/src/Model.cpp | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h index 678dc5a3e2..1bddaedc42 100644 --- a/interface/src/avatar/AvatarManager.h +++ b/interface/src/avatar/AvatarManager.h @@ -37,8 +37,8 @@ using SortedAvatar = std::pair>; /**jsdoc - * The AvatarManager API provides information about avatars within the domain. The avatars available are those - * that Interface has displayed and so knows about. + * The AvatarManager API provides information about avatars within the current domain. The avatars available are + * those that Interface has displayed and therefore knows about. * *

Warning: This API is also provided to Interface, client entity, and avatar scripts as the synonym, * "AvatarList". For assignment client scripts, see the separate {@link AvatarList} API.

@@ -139,7 +139,7 @@ public: /**jsdoc * Gets the amount of avatar mixer data being generated by an avatar other than your own. * @function AvatarManager.getAvatarDataRate - * @param {Uuid} sessionID - The ID of the avatar to get the data rate for. + * @param {Uuid} sessionID - The ID of the avatar whose data rate you're retrieving. * @param {AvatarDataRate} [rateName=""] - The type of avatar mixer data to get the data rate of. * @returns {number} The data rate in kbps; 0 if the avatar is your own. */ @@ -148,7 +148,7 @@ public: /**jsdoc * Gets the update rate of avatar mixer data being generated by an avatar other than your own. * @function AvatarManager.getAvatarUpdateRate - * @param {Uuid} sessionID - The ID of the avatar to get the update rate for. + * @param {Uuid} sessionID - The ID of the avatar whose update rate you're retrieving. * @param {AvatarUpdateRate} [rateName=""] - The type of avatar mixer data to get the update rate of. * @returns {number} The update rate in Hz; 0 if the avatar is your own. */ @@ -157,7 +157,7 @@ public: /**jsdoc * Gets the simulation rate of an avatar other than your own. * @function AvatarManager.getAvatarSimulationRate - * @param {Uuid} sessionID - The ID of the avatar to get the simulation rate for. + * @param {Uuid} sessionID - The ID of the avatar whose simulation you're retrieving. * @param {AvatarSimulationRate} [rateName=""] - The type of avatar data to get the simulation rate of. * @returns {number} The simulation rate in Hz; 0 if the avatar is your own. */ @@ -236,10 +236,10 @@ public: * Gets PAL (People Access List) data for one or more avatars. Using this method is faster than iterating over each avatar * and obtaining data about each individually. * @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. + * @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. - * @example Report the PAL data for one nearby 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/libraries/avatars/src/AvatarHashMap.h b/libraries/avatars/src/AvatarHashMap.h index 3340635c82..17a3d28eb0 100644 --- a/libraries/avatars/src/AvatarHashMap.h +++ b/libraries/avatars/src/AvatarHashMap.h @@ -36,7 +36,7 @@ const int CLIENT_TO_AVATAR_MIXER_BROADCAST_FRAMES_PER_SECOND = 50; const quint64 MIN_TIME_BETWEEN_MY_AVATAR_DATA_SENDS = USECS_PER_SECOND / CLIENT_TO_AVATAR_MIXER_BROADCAST_FRAMES_PER_SECOND; /**jsdoc - * The AvatarList API provides information about avatars within the domain. + * The AvatarList API provides information about avatars within the current domain. * *

Warning: An API named "AvatarList" is also provided for Interface, client entity, and avatar * scripts, however, it is a synonym for the {@link AvatarManager} API.

diff --git a/libraries/avatars/src/ScriptAvatarData.h b/libraries/avatars/src/ScriptAvatarData.h index 61ceb88480..7e33618ba9 100644 --- a/libraries/avatars/src/ScriptAvatarData.h +++ b/libraries/avatars/src/ScriptAvatarData.h @@ -46,7 +46,7 @@ * * @property {string} skeletonModelURL - The avatar's FST file. * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments.
- * Deprecated: Use avatar entities insteada. + * Deprecated: Use avatar entities instead. * @property {string[]} jointNames - The list of joints in the current avatar model. * * @property {number} audioLoudness - The instantaneous loudness of the audio input that the avatar is injecting into the diff --git a/libraries/render-utils/src/Model.cpp b/libraries/render-utils/src/Model.cpp index ff0fa4ac3b..2a35b0d161 100644 --- a/libraries/render-utils/src/Model.cpp +++ b/libraries/render-utils/src/Model.cpp @@ -453,9 +453,9 @@ bool Model::findRayIntersectionAgainstSubMeshes(const glm::vec3& origin, const g * @property {number} shapeID - The index of the mesh part within the model. * @property {number} subMeshIndex - The index of the intersected submesh within the model. * @property {string} subMeshName - The name of the intersected submesh. - * @property {Triangle} subMeshTriangleWorld - The vertexes of the intersected mesh part triangle in world coordinates. + * @property {Triangle} subMeshTriangleWorld - The vertices of the intersected mesh part triangle in world coordinates. * @property {Vec3} subMeshNormal - The normal of the intersected mesh part triangle in model coordinates. - * @property {Triangle} subMeshTriangle - The vertexes of the intersected mesh part triangle in model coordinates. + * @property {Triangle} subMeshTriangle - The vertices of the intersected mesh part triangle in model coordinates. */ if (intersectedSomething) { distance = bestDistance;