JSDoc revisions for PR16245

This commit is contained in:
ingerjm0 2019-11-12 14:47:09 -08:00
parent ce174696c0
commit dda69bf91a

View file

@ -1790,12 +1790,11 @@ public:
Q_INVOKABLE void releaseEyesLookAtControl(); Q_INVOKABLE void releaseEyesLookAtControl();
/**jsdoc /**jsdoc
* Aims the pointing directional blending towards the provided target point. * Aims the pointing directional blending towards the provided target point. The "point" reaction should be triggered
* The "point" reaction should be triggered before using this method. * before using this method with the code <code>MyAvatar.beginReaction("point")</code>.
* <code>MyAvatar.beginReaction("point")</code>
* Returns <code>true</code> if the target point lays in front of the avatar.
* @function MyAvatar.setPointAt * @function MyAvatar.setPointAt
* @param {Vec3} pointAtTarget - The target point in world coordinates. * @param {Vec3} pointAtTarget - The target point in world coordinates.
* @returns {boolean} <code>true</code> if the target point lays in front of the avatar; <code>false</code> otherwise.
*/ */
Q_INVOKABLE bool setPointAt(const glm::vec3& pointAtTarget); Q_INVOKABLE bool setPointAt(const glm::vec3& pointAtTarget);