Doc review updates

This commit is contained in:
David Rowe 2019-04-11 10:27:17 +12:00
parent 617617736e
commit a7b1d613d3

View file

@ -47,8 +47,8 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* Gets the ID of the entity that the camera is set to use the position and orientation from when it's in entity mode. You * Gets the ID of the entity that the camera is set to follow (i.e., use the position and orientation from) when it's in
* can also get the entity ID using the {@link Camera|Camera.cameraEntity} property. * entity mode. You can also get the entity ID using the {@link Camera|Camera.cameraEntity} property.
* @function Camera.getCameraEntity * @function Camera.getCameraEntity
* @returns {Uuid} The ID of the entity that the camera is set to follow when in entity mode; <code>null</code> if no * @returns {Uuid} The ID of the entity that the camera is set to follow when in entity mode; <code>null</code> if no
* camera entity has been set. * camera entity has been set.
@ -56,8 +56,8 @@ public slots:
QUuid getCameraEntity() const; QUuid getCameraEntity() const;
/**jsdoc /**jsdoc
* Sets the entity that the camera should use the position and orientation from when it's in entity mode. You can also set * Sets the entity that the camera should follow (i.e., use the position and orientation from) when it's in entity mode.
* the entity using the {@link Camera|Camera.cameraEntity} property. * You can also set the entity using the {@link Camera|Camera.cameraEntity} property.
* @function Camera.setCameraEntity * @function Camera.setCameraEntity
* @param {Uuid} entityID - The entity that the camera should follow when it's in entity mode. * @param {Uuid} entityID - The entity that the camera should follow when it's in entity mode.
* @example <caption>Move your camera to the position and orientation of the closest entity.</caption> * @example <caption>Move your camera to the position and orientation of the closest entity.</caption>