Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-04-06 16:42:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Review JSDoc updates from recent commits

Browse source
This commit is contained in:
David Rowe 2020-01-20 14:33:06 +13:00
parent c6cde9f0c9
commit 1a4266a64a
15 changed files with 35 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
assignment-client/src/avatars/ScriptableAvatar.h
View file

@ -82,15 +82,15 @@
* <p><strong>Note:</strong> This property will automatically be set to true if the Controller system has valid facial
* blend shape actions.</p>
* @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set this property to <code>false</code> if
* you wish to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set to <code>false</code> to fully control
* the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set this property to
* <code>false</code> if you wish to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set to <code>false</code> to
* fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set
* this property to <code>false</code> if you wish to fully control the mouth facial blend shapes via the
* this property to <code>false</code> to fully control the mouth facial blend shapes via the
* {@link MyAvatar.setBlendshape} method.
*
* @example <caption>Create a scriptable avatar.</caption>

18
interface/src/avatar/MyAvatar.h
View file

@ -154,12 +154,12 @@ class MyAvatar : public Avatar {
* <p><strong>Note:</strong> This property will automatically be set to <code>true</code> if the controller system has
* valid facial blend shape actions.</p>
* @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set this property to <code>false</code>
* to fully control the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set to <code>false</code> to fully control
* the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set this property to
* <code>false</code> to fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set to <code>false</code> to
* fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set
* this property to <code>false</code> to fully control the mouth facial blend shapes via the
@ -1793,15 +1793,15 @@ public:
/**jsdoc
* Turns the avatar's head until it faces the target point within a +90/-90 degree range.
* Once this method is called, API calls will have full control of the head for a limited time.
* If this method is not called for 2 seconds, the engine will regain control of the head.
* Once this method is called, API calls have full control of the head for a limited time.
* If this method is not called for 2 seconds, the engine regains control of the head.
* @function MyAvatar.setHeadLookAt
* @param {Vec3} lookAtTarget - The target point in world coordinates.
*/
Q_INVOKABLE void setHeadLookAt(const glm::vec3& lookAtTarget);
/**jsdoc
* Returns the current target point of the head's look direction in world coordinates.
* Gets the current target point of the head's look direction in world coordinates.
* @function MyAvatar.getHeadLookAt
* @returns {Vec3} The head's look-at target in world coordinates.
*/
@ -1815,7 +1815,7 @@ public:
/**jsdoc
* Forces the avatar's eyes to look at a specified location. Once this method is called, API calls
* have full control of the eyes for a limited time. If this method is not called for two seconds,
* full control of the eyes for a limited time. If this method is not called for 2 seconds,
* the engine regains control of the eyes.
* @function MyAvatar.setEyesLookAt
* @param {Vec3} lookAtTarget - The target point in world coordinates.
@ -1823,7 +1823,7 @@ public:
Q_INVOKABLE void setEyesLookAt(const glm::vec3& lookAtTarget);
/**jsdoc
* Returns the current target point of the eyes look direction in world coordinates.
* Gets the current target point of the eyes look direction in world coordinates.
* @function MyAvatar.getEyesLookAt
* @returns {Vec3} The eyes' look-at target in world coordinates.
*/

2
interface/src/ui/InteractiveWindow.cpp
View file

@ -145,7 +145,7 @@ void InteractiveWindow::emitMainWindowResizeEvent() {
* @property {InteractiveWindow.Flags} [additionalFlags=0] - Customizes window behavior.
* @property {InteractiveWindow.OverrideFlags} [overrideFlags=0] - Customizes window controls.
* @property {InteractiveWindow.RelativePositionAnchor} [relativePositionAnchor] - he anchor for the
* @property {InteractiveWindow.RelativePositionAnchor} [relativePositionAnchor] - The anchor for the
* <code>relativePosition</code>, if used.
* @property {Vec2} [relativePosition] - The position of the window, relative to the <code>relativePositionAnchor</code>, in
* pixels. Excludes the window frame.

2
libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp
View file

@ -1925,7 +1925,7 @@ void Avatar::setParentJointIndex(quint16 parentJointIndex) {
* @typedef {object} SkeletonJoint
* @property {string} name - Joint name.
* @property {number} index - Joint index.
* @property {number} parentIndex - Index of this joint's parent (-1 if no parent).
* @property {number} parentIndex - Index of this joint's parent (<code>-1</code> if no parent).
*/
QList<QVariant> Avatar::getSkeleton() {
SkeletonModelPointer skeletonModel = _skeletonModel;

4
libraries/avatars-renderer/src/avatars-renderer/Avatar.h
View file

@ -442,7 +442,7 @@ public:
void setOrientationViaScript(const glm::quat& orientation) override;
/**jsdoc
* Gets the ID of the entity of avatar that the avatar is parented to.
* Gets the ID of the entity or avatar that the avatar is parented to.
* @function MyAvatar.getParentID
* @returns {Uuid} The ID of the entity or avatar that the avatar is parented to. {@link Uuid(0)|Uuid.NULL} if not parented.
*/
@ -450,7 +450,7 @@ public:
Q_INVOKABLE virtual const QUuid getParentID() const override { return SpatiallyNestable::getParentID(); }
/**jsdoc
* Sets the ID of the entity of avatar that the avatar is parented to.
* Sets the ID of the entity or avatar that the avatar is parented to.
* @function MyAvatar.setParentID
* @param {Uuid} parentID - The ID of the entity or avatar that the avatar should be parented to. Set to
* {@link Uuid(0)|Uuid.NULL} to unparent.

4
libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h
View file

@ -19,7 +19,7 @@
/**jsdoc
* Information about an avatar.
*
* <p>Created using {@link MyAvatar.getTargetAvatar} or {@link AvatarList.getAvatar}.</p>
* <p>Create using {@link MyAvatar.getTargetAvatar} or {@link AvatarList.getAvatar}.</p>
*
* @class ScriptAvatar
* @hideconstructor
@ -152,7 +152,7 @@ public slots:
/**jsdoc
* Gets the ID of the entity of avatar that the avatar is parented to.
* Gets the ID of the entity or avatar that the avatar is parented to.
* @function ScriptAvatar.getParentID
* @returns {Uuid} The ID of the entity or avatar that the avatar is parented to. {@link Uuid(0)|Uuid.NULL} if not parented
* or avatar data aren't available.

10
libraries/avatars/src/AvatarData.h
View file

@ -538,12 +538,12 @@ class AvatarData : public QObject, public SpatiallyNestable {
* <p><strong>Note:</strong> This property will automatically be set to <code>true</code> if the controller system has
* valid facial blend shape actions.</p>
* @property {boolean} hasProceduralBlinkFaceMovement=true - <code>true</code> if avatars blink automatically by animating
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set this property to <code>false</code>
* to fully control the blink facial blend shapes via the {@link Avatar.setBlendshape} method.
* facial blend shapes, <code>false</code> if automatic blinking is disabled. Set to <code>false</code> to fully control
* the blink facial blend shapes via the {@link Avatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - <code>true</code> if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, <code>false</code> if this automatic movement is disabled. Set this property
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set this property to
* <code>false</code> to fully control the eye blend shapes via the {@link Avatar.setBlendshape} method.
* to <code>true</code> to prevent the iris from being obscured by the upper or lower lids. Set to <code>false</code> to
* fully control the eye blend shapes via the {@link Avatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - <code>true</code> if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, <code>false</code> if this automatic movement is disabled. Set
* this property to <code>false</code> to fully control the mouth facial blend shapes via the
@ -1542,7 +1542,7 @@ signals:
void sessionDisplayNameChanged();
/**jsdoc
* Triggered when the avatar's model (i.e., <code>skeletonModelURL</code> property value) is changed.
* Triggered when the avatar's model (i.e., <code>skeletonModelURL</code> property value) changes.
* @function Avatar.skeletonModelURLChanged
* @returns {Signal}
* @example <caption>Report when your avatar's skeleton model changes.</caption>

2
libraries/avatars/src/ScriptAvatarData.h
View file

@ -248,7 +248,7 @@ signals:
void sessionDisplayNameChanged();
/**jsdoc
* Triggered when the avatar's model (i.e., <code>skeletonModelURL</code> property value) is changed.
* Triggered when the avatar's model (i.e., <code>skeletonModelURL</code> property value) changes.
* @function ScriptAvatar.skeletonModelURLChanged
* @returns {Signal}
*/

2
libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.cpp
View file

@ -434,7 +434,7 @@ namespace scriptable {
* @property {string} [glossMap] - The URL of the gloss texture image.
* Only use one of <code>roughnessMap</code> and <code>glossMap</code>.
* <code>"hifi_pbr"</code> model only.
* @property {string} [normalMa]p - The URL of the normal texture image.
* @property {string} [normalMap] - The URL of the normal texture image.
* If <code>"fallthrough"</code> then it and <code>bumpMap</code> fall through to the material below.
* Only use one of <code>normalMap</code> and <code>bumpMap</code>.
* <code>"hifi_pbr"</code> model only.

4
libraries/graphics-scripting/src/graphics-scripting/ScriptableMesh.h
View file

@ -31,7 +31,7 @@ namespace scriptable {
/**jsdoc
* A handle to in-memory mesh data in a {@link GraphicsModel}.
*
* <p>Created using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, or {@link GraphicsMesh.cloneMesh}.</p>
* <p>Create using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, or {@link GraphicsMesh.cloneMesh}.</p>
*
* @class GraphicsMesh
* @hideconstructor
@ -133,7 +133,7 @@ namespace scriptable {
QVector<glm::uint32> findNearbyVertexIndices(const glm::vec3& origin, float epsilon = 1e-6) const;
/**jsdoc
* Adds an attribute to the (whole) mesh's vertices.
* Adds an attribute for all vertices.
* @function GraphicsMesh.addAttribute
* @param {Graphics.BufferTypeName} name - The name of the attribute.
* @param {Graphics.BufferType} [defaultValue] - The value to give the attributes added to the vertices.

2
libraries/graphics-scripting/src/graphics-scripting/ScriptableMeshPart.h
View file

@ -13,7 +13,7 @@ namespace scriptable {
/**jsdoc
* A handle to in-memory mesh part data in a {@link GraphicsModel}.
*
* <p>Created using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, {@link GraphicsMesh.cloneMesh}, or
* <p>Create using the {@link Graphics} API, {@link GraphicsModel.cloneModel}, {@link GraphicsMesh.cloneMesh}, or
* {@link GraphicsMeshPart.cloneMeshPart}.</p>
*
* @class GraphicsMeshPart

4
libraries/graphics-scripting/src/graphics-scripting/ScriptableModel.h
View file

@ -22,7 +22,7 @@ namespace scriptable {
* <p>Note: The model may be used for more than one instance of an item displayed in the scene. Modifying the model updates
* all instances displayed.</p>
*
* <p>Created using the {@link Graphics} API or {@link GraphicsModel.cloneModel}.</p>
* <p>Create using the {@link Graphics} API or {@link GraphicsModel.cloneModel}.</p>
*
* @class GraphicsModel
* @hideconstructor
@ -34,7 +34,7 @@ namespace scriptable {
* @property {Uuid} objectID - The ID of the entity or avatar that the model is associated with, if any; <code>null</code>
* if the model is not associated with an entity or avatar.
* <em>Read-only.</em>
* @property {number} numMeshes - The number of meshes contained in the model.
* @property {number} numMeshes - The number of meshes in the model.
* <em>Read-only.</em>
* @property {GraphicsMesh[]} meshes - The meshes in the model. Each mesh may have more than one mesh part.
* <em>Read-only.</em>

2
libraries/graphics/src/graphics/BufferViewHelpers.cpp
View file

@ -76,7 +76,7 @@ const std::array<const char*, 4> ZERO123 = { { "0", "1", "2", "3" } };
* <tr><td>{@link Vec2}</td><td><code>"texcoord4"</code></td><td>Fifth UV coordinates buffer.</td></tr>
* </tbody>
* </table>
* @typedef {Vec3|vec2} Graphics.BufferType
* @typedef {Vec4|Vec3|Vec2} Graphics.BufferType
*/
QMap<QString,int> ATTRIBUTES{
{"position", gpu::Stream::POSITION },

2
libraries/shared/src/JointData.h
View file

@ -16,7 +16,7 @@ public:
// Used by the avatar mixer to describe a single joint
// Translations relative to their parent joint
// Rotations are absolute (i.e. not relative to parent) and are in rig space.
// No JSDoc because its not provided as a type to the script engine.
// No JSDoc because it's not provided as a type to the script engine.
class JointData {
public:
glm::quat rotation;

2
libraries/shared/src/RegisteredMetaTypes.cpp
View file

@ -1309,7 +1309,7 @@ void meshesFromScriptValue(const QScriptValue& value, MeshProxyList &out) {
/**jsdoc
* A triangle in a mesh.
* @typedef {object} MeshFace
* @property {number[]} vertices - The indexes of the three vertices that make up the fase.
* @property {number[]} vertices - The indexes of the three vertices that make up the face.
*/
QScriptValue meshFaceToScriptValue(QScriptEngine* engine, const MeshFace &meshFace) {
QScriptValue obj = engine->newObject();