From ffb73d5dbf432913dffe3ae152feed17963c9f66 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Tue, 8 Oct 2019 11:22:19 +1300
Subject: [PATCH] Steam JSDoc

---
 .../plugins/src/plugins/SteamClientPlugin.h      | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/libraries/plugins/src/plugins/SteamClientPlugin.h b/libraries/plugins/src/plugins/SteamClientPlugin.h
index 2124d16b5e..07e320f8eb 100644
--- a/libraries/plugins/src/plugins/SteamClientPlugin.h
+++ b/libraries/plugins/src/plugins/SteamClientPlugin.h
@@ -41,13 +41,16 @@ public:
 };
 
 /**jsdoc
+ * The <code>Steam</code> API provides facilities for working with the Steam version of Interface.
+ *
  * @namespace Steam
  *
  * @hifi-interface
  * @hifi-client-entity
  * @hifi-avatar
  *
- * @property {boolean} running - <em>Read-only.</em>
+ * @property {boolean} running - <code>true</code> if Interface is running under Steam, <code>false</code> if it isn't. 
+ *     <em>Read-only.</em>
  */
 
 class SteamScriptingInterface : public QObject {
@@ -61,13 +64,22 @@ public:
 public slots:
 
     /**jsdoc
+     * Gets whether Interface is running under Steam.
      * @function Steam.isRunning
-     * @returns {boolean}
+     * @returns {boolean} <code>true</code> if Interface is running under Steam, <code>false</code> if it isn't. 
      */
     bool isRunning() const { return _plugin && _plugin->isRunning(); }
 
     /**jsdoc
+     * Opens Steam's "Choose Friends to invite" dialog if Interface is running under Steam.
      * @function Steam.openInviteOverlay
+     * @example <caption>Invite Steam friends to join you in High Fidelity.</caption>
+     * if (Steam.running) {
+     *     print("Invite Steam friends to joint you...");
+     *     Steam.openInviteOverlay();
+     * } else {
+     *     print("Interface isn't running under Steam.");
+     * }
      */
     void openInviteOverlay() const { if (_plugin) { _plugin->openInviteOverlay(); } }