From 3891ebe7039432c288414234a9c7cb46d025d775 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Fri, 11 May 2018 20:20:07 +1200
Subject: [PATCH] Agent API JSDoc stubs

---
 assignment-client/src/Agent.h                 | 30 +++++++++++++++++++
 libraries/networking/src/ThreadedAssignment.h | 20 +++++++++++++
 tools/jsdoc/plugins/hifi.js                   |  1 +
 3 files changed, 51 insertions(+)

diff --git a/assignment-client/src/Agent.h b/assignment-client/src/Agent.h
index 0cdc9e0029..00ef034ad5 100644
--- a/assignment-client/src/Agent.h
+++ b/assignment-client/src/Agent.h
@@ -33,6 +33,19 @@
 #include "entities/EntityTreeHeadlessViewer.h"
 #include "avatars/ScriptableAvatar.h"
 
+/**jsdoc
+ * @namespace Agent
+ *
+ * @hifi-assignment-client
+ *
+ * @property {boolean} isAvatar
+ * @property {boolean} isPlayingAvatarSound <em>Read-only.</em>
+ * @property {boolean} isListeningToAudioStream
+ * @property {boolean} isNoiseGateEnabled
+ * @property {number} lastReceivedAudioLoudness <em>Read-only.</em>
+ * @property {Uuid} sessionUUID <em>Read-only.</em>
+ */
+
 class Agent : public ThreadedAssignment {
     Q_OBJECT
 
@@ -60,10 +73,27 @@ public:
     virtual void aboutToFinish() override;
 
 public slots:
+    /**jsdoc
+     * @function Agent.run
+     */
     void run() override;
+
+    /**jsdoc
+     * @function Agent.playAvatarSound
+     * @param {object} avatarSound
+     */
     void playAvatarSound(SharedSoundPointer avatarSound);
     
+    /**jsdoc
+     * @function Agent.setIsAvatar
+     * @param {boolean} isAvatar
+     */
     void setIsAvatar(bool isAvatar);
+
+    /**jsdoc
+     * @function Agent.isAvatar
+     * @returns {boolean}
+     */
     bool isAvatar() const { return _isAvatar; }
 
 private slots:
diff --git a/libraries/networking/src/ThreadedAssignment.h b/libraries/networking/src/ThreadedAssignment.h
index 007e41a543..d19617357b 100644
--- a/libraries/networking/src/ThreadedAssignment.h
+++ b/libraries/networking/src/ThreadedAssignment.h
@@ -29,13 +29,30 @@ public:
     void addPacketStatsAndSendStatsPacket(QJsonObject statsObject);
 
 public slots:
+    // JSDoc: Overridden in Agent.h.
     /// threaded run of assignment
     virtual void run() = 0;
+
+    /**jsdoc
+     * @function Agent.stop
+     */
     Q_INVOKABLE virtual void stop() { setFinished(true); }
+
+    /**jsdoc
+     * @function Agent.sendStatsPacket
+     */
     virtual void sendStatsPacket();
+
+    /**jsdoc
+     * @function Agent.clearQueuedCheckIns
+     */
     void clearQueuedCheckIns() { _numQueuedCheckIns = 0; }
 
 signals:
+    /**jsdoc
+     * @function Agent.finished
+     * @returns {Signal}
+     */
     void finished();
 
 protected:
@@ -47,6 +64,9 @@ protected:
     int _numQueuedCheckIns { 0 };
 
 protected slots:
+    /**jsdoc
+     * @function Agent.domainSettingsRequestFailed
+     */
     void domainSettingsRequestFailed();
 
 private slots:
diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js
index 5092e8b809..eb47bec430 100644
--- a/tools/jsdoc/plugins/hifi.js
+++ b/tools/jsdoc/plugins/hifi.js
@@ -20,6 +20,7 @@ exports.handlers = {
 
         // directories to scan for jsdoc comments
         var dirList = [
+            '../../assignment-client/src',
             '../../interface/src',
             '../../interface/src/assets',
             '../../interface/src/audio',