From fb1f7fea90f358868c88fe24879a784007604559 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Sun, 13 May 2018 10:32:46 +1200
Subject: [PATCH] Steam API JSDoc stubs

---
 .../plugins/src/plugins/SteamClientPlugin.h    | 18 ++++++++++++++++++
 tools/jsdoc/plugins/hifi.js                    |  1 +
 2 files changed, 19 insertions(+)

diff --git a/libraries/plugins/src/plugins/SteamClientPlugin.h b/libraries/plugins/src/plugins/SteamClientPlugin.h
index 343ed40402..fc1b85c572 100644
--- a/libraries/plugins/src/plugins/SteamClientPlugin.h
+++ b/libraries/plugins/src/plugins/SteamClientPlugin.h
@@ -40,6 +40,15 @@ public:
     virtual int getSteamVRBuildID() = 0;
 };
 
+/**jsdoc
+ * @namespace Steam
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
+ * @property {boolean} running - <em>Read-only.</em>
+ */
+
 class SteamScriptingInterface : public QObject {
     Q_OBJECT
 
@@ -49,7 +58,16 @@ public:
     SteamScriptingInterface(QObject* parent, SteamClientPlugin* plugin) : QObject(parent), _plugin(plugin) {}
 
 public slots:
+
+    /**jsdoc
+     * @function Steam.isRunning
+     * @returns {boolean}
+     */
     bool isRunning() const { return _plugin && _plugin->isRunning(); }
+
+    /**jsdoc
+     * @function Steam.openInviteOverlay
+     */
     void openInviteOverlay() const { if (_plugin) { _plugin->openInviteOverlay(); } }
 
 private:
diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js
index 8a2a5cd0b5..91f6476772 100644
--- a/tools/jsdoc/plugins/hifi.js
+++ b/tools/jsdoc/plugins/hifi.js
@@ -52,6 +52,7 @@ exports.handlers = {
             '../../libraries/networking/src',
             '../../libraries/octree/src',
             '../../libraries/physics/src',
+            '../../libraries/plugins/src/plugins',
             '../../libraries/pointers/src',
             '../../libraries/script-engine/src',
             '../../libraries/shared/src',