From 539c2802817db71a6c4c5b4dfe566c5329ba8212 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Fri, 5 Oct 2018 15:13:13 +1300
Subject: [PATCH 1/3] Fill in missing JSDoc stubs in AvatarList and
 AvatarManager

---
 interface/src/avatar/AvatarManager.h  | 7 +++++++
 libraries/avatars/src/AvatarHashMap.h | 5 +++++
 2 files changed, 12 insertions(+)

diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h
index 3ed156f673..8634dca953 100644
--- a/interface/src/avatar/AvatarManager.h
+++ b/interface/src/avatar/AvatarManager.h
@@ -54,6 +54,7 @@ using SortedAvatar = std::pair<float, std::shared_ptr<Avatar>>;
  * @borrows AvatarList.sessionUUIDChanged as sessionUUIDChanged
  * @borrows AvatarList.processAvatarDataPacket as processAvatarDataPacket
  * @borrows AvatarList.processAvatarIdentityPacket as processAvatarIdentityPacket
+ * @borrows AvatarList.processBulkAvatarTraits as processBulkAvatarTraits
  * @borrows AvatarList.processKillAvatar as processKillAvatar
  */
 
@@ -151,6 +152,12 @@ public:
                                                                         const QVector<EntityItemID>& avatarsToInclude,
                                                                         const QVector<EntityItemID>& avatarsToDiscard);
 
+    /**jsdoc
+     * @function AvatarManager.findParabolaIntersectionVector
+     * @param {PickParabola} pick
+     * @param {Uuid[]} avatarsToInclude
+     * @param {Uuid[]} avatarsToDiscard
+     */
     Q_INVOKABLE ParabolaToAvatarIntersectionResult findParabolaIntersectionVector(const PickParabola& pick,
                                                                                   const QVector<EntityItemID>& avatarsToInclude,
                                                                                   const QVector<EntityItemID>& avatarsToDiscard);
diff --git a/libraries/avatars/src/AvatarHashMap.h b/libraries/avatars/src/AvatarHashMap.h
index c2cb448e52..4d6bf6ea81 100644
--- a/libraries/avatars/src/AvatarHashMap.h
+++ b/libraries/avatars/src/AvatarHashMap.h
@@ -161,6 +161,11 @@ protected slots:
      */
     void processAvatarIdentityPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
     
+    /**jsdoc
+     * @function AvatarList.processBulkAvatarTraits
+     * @param {} message
+     * @param {} sendingNode
+     */
     void processBulkAvatarTraits(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
     
     /**jsdoc

From 2ba8dc37d0c2c5a087e229d7d9c69dc2938cfceb Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Fri, 5 Oct 2018 16:57:29 +1300
Subject: [PATCH 2/3] Miscellanous JSDoc fixes for issues noticed in passing

---
 interface/src/avatar/AvatarManager.h | 2 +-
 libraries/pointers/src/Pick.h        | 9 ++++++---
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h
index 8634dca953..cc59f21c7d 100644
--- a/interface/src/avatar/AvatarManager.h
+++ b/interface/src/avatar/AvatarManager.h
@@ -182,7 +182,7 @@ public:
      * 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.
      * @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
      * @returns {object}
      */
diff --git a/libraries/pointers/src/Pick.h b/libraries/pointers/src/Pick.h
index bde38575ee..a1c86ed32e 100644
--- a/libraries/pointers/src/Pick.h
+++ b/libraries/pointers/src/Pick.h
@@ -145,9 +145,11 @@ public:
      * @hifi-interface
      * @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} 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} 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} 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
      * <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.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.Collision}</code></td><td></td></tr>
      *   </tbody>
      * </table>
      * @typedef {number} PickType

From 353938193e911d74bb7e550665569417d920581b Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Wed, 17 Oct 2018 08:03:56 +1300
Subject: [PATCH 3/3] Add return value

---
 interface/src/avatar/AvatarManager.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h
index cc59f21c7d..8927ff2909 100644
--- a/interface/src/avatar/AvatarManager.h
+++ b/interface/src/avatar/AvatarManager.h
@@ -157,6 +157,7 @@ public:
      * @param {PickParabola} pick
      * @param {Uuid[]} avatarsToInclude
      * @param {Uuid[]} avatarsToDiscard
+     * @returns {ParabolaToAvatarIntersectionResult}
      */
     Q_INVOKABLE ParabolaToAvatarIntersectionResult findParabolaIntersectionVector(const PickParabola& pick,
                                                                                   const QVector<EntityItemID>& avatarsToInclude,