Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-07 05:09:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Miscellanous JSDoc fixes for issues noticed in passing

Browse source
This commit is contained in:
David Rowe 2018-10-05 16:57:29 +13:00
parent 539c280281
commit 2ba8dc37d0
2 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
interface/src/avatar/AvatarManager.h
View file

@ -182,7 +182,7 @@ public:
* than iterating over each avatar and obtaining data about them in JavaScript, as that method * than iterating over each avatar and obtaining data about them in JavaScript, as that method
* locks and unlocks each avatar's data structure potentially hundreds of times per update tick. * locks and unlocks each avatar's data structure potentially hundreds of times per update tick.
* @function AvatarManager.getPalData * @function AvatarManager.getPalData
* @param {string[]} specificAvatarIdentifiers - A list of specific Avatar Identifiers about * @param {string[]} [specificAvatarIdentifiers] - A list of specific Avatar Identifiers about
* which you want to get PAL data * which you want to get PAL data
* @returns {object} * @returns {object}
*/ */

9
libraries/pointers/src/Pick.h
View file

@ -145,9 +145,11 @@ public:
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* *
* @property {number} Ray Ray Picks intersect a ray with the nearest object in front of them, along a given direction. * @property {number} Ray Ray picks intersect a ray with the nearest object in front of them, along a given direction.
* @property {number} Stylus Stylus Picks provide "tapping" functionality on/into flat surfaces. * @property {number} Stylus Stylus picks provide "tapping" functionality on/into flat surfaces.
* @property {number} Parabola Parabola Picks intersect a parabola with the nearest object in front of them, with a given initial velocity and acceleration. * @property {number} Parabola Parabola picks intersect a parabola with the nearest object in front of them, with a given
* initial velocity and acceleration.
* @property {number} Collision Collision picks intersect a collision volume with avatars and entities that have collisions.
*/ */
/**jsdoc /**jsdoc
* <table> * <table>
@ -158,6 +160,7 @@ public:
* <tr><td><code>{@link PickType(0)|PickType.Ray}</code></td><td></td></tr> * <tr><td><code>{@link PickType(0)|PickType.Ray}</code></td><td></td></tr>
* <tr><td><code>{@link PickType(0)|PickType.Stylus}</code></td><td></td></tr> * <tr><td><code>{@link PickType(0)|PickType.Stylus}</code></td><td></td></tr>
* <tr><td><code>{@link PickType(0)|PickType.Parabola}</code></td><td></td></tr> * <tr><td><code>{@link PickType(0)|PickType.Parabola}</code></td><td></td></tr>
* <tr><td><code>{@link PickType(0)|PickType.Collision}</code></td><td></td></tr>
* </tbody> * </tbody>
* </table> * </table>
* @typedef {number} PickType * @typedef {number} PickType