From cf855391af34d47a44e0ca5e46a7b9da534701c2 Mon Sep 17 00:00:00 2001
From: "Anthony J. Thibault" <tony@highfidelity.io>
Date: Tue, 31 Jan 2017 16:54:15 -0800
Subject: [PATCH] Added jsdocs for all button properties

---
 .../script-engine/src/TabletScriptingInterface.h  | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/libraries/script-engine/src/TabletScriptingInterface.h b/libraries/script-engine/src/TabletScriptingInterface.h
index b0b2d00e0f..0b7829c7fb 100644
--- a/libraries/script-engine/src/TabletScriptingInterface.h
+++ b/libraries/script-engine/src/TabletScriptingInterface.h
@@ -119,7 +119,7 @@ public:
      * @param msg {object|string}
      */
     Q_INVOKABLE void emitScriptEvent(QVariant msg);
-    
+
     Q_INVOKABLE bool onHomeScreen();
 
     QObject* getTabletSurface();
@@ -170,14 +170,14 @@ public:
     /**jsdoc
      * Returns the current value of this button's properties
      * @function TabletButtonProxy#getProperties
-     * @returns {object}
+     * @returns {ButtonProperties}
      */
     Q_INVOKABLE QVariantMap getProperties() const;
 
     /**jsdoc
      * Replace the values of some of this button's properties
      * @function TabletButtonProxy#editProperties
-     * @param properties {object} set of properties to change
+     * @param {ButtonProperties} properties - set of properties to change
      */
     Q_INVOKABLE void editProperties(QVariantMap properties);
 
@@ -199,4 +199,13 @@ protected:
     QVariantMap _properties;
 };
 
+/**jsdoc
+ * @typedef TabletButtonProxy.ButtonProperties
+ * @property {string} text - button caption
+ * @property {string} icon - url to button icon. (50 x 50)
+ * @property {string} activeText - button caption when button is active
+ * @property {string} activeIcon - url to button icon used when button is active. (50 x 50)
+ * @property {string} isActive - true when button is active.
+ */
+
 #endif // hifi_TabletScriptingInterface_h