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

---
 .../ui/src/ui/ToolbarScriptingInterface.h     | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/libraries/ui/src/ui/ToolbarScriptingInterface.h b/libraries/ui/src/ui/ToolbarScriptingInterface.h
index 108cf6bdd5..4b9bd79fb3 100644
--- a/libraries/ui/src/ui/ToolbarScriptingInterface.h
+++ b/libraries/ui/src/ui/ToolbarScriptingInterface.h
@@ -19,14 +19,30 @@
 
 class QQuickItem;
 
+/**jsdoc
+ * @class ToolbarButtonProxy
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ */
 class ToolbarButtonProxy : public QmlWrapper {
     Q_OBJECT
 
 public:
     ToolbarButtonProxy(QObject* qmlObject, QObject* parent = nullptr);
+
+    /**jsdoc
+     * @function ToolbarButtonProxy#editProperties
+     * @param {object} properties
+     */
     Q_INVOKABLE void editProperties(const QVariantMap& properties);
 
 signals:
+
+    /**jsdoc
+     * @function ToolbarButtonProxy#clicked
+     * @returns {Signal}
+     */
     void clicked();
 
 protected:
@@ -36,19 +52,48 @@ protected:
 
 Q_DECLARE_METATYPE(ToolbarButtonProxy*);
 
+/**jsdoc
+ * @class ToolbarProxy
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ */
 class ToolbarProxy : public QmlWrapper {
     Q_OBJECT
 public:
     ToolbarProxy(QObject* qmlObject, QObject* parent = nullptr);
+
+    /**jsdoc
+     * @function ToolbarProxy#addButton
+     * @property {object} properties
+     * @returns {ToolbarButtonProxy}
+     */
     Q_INVOKABLE ToolbarButtonProxy* addButton(const QVariant& properties);
+
+    /**jsdoc
+     * @function ToolbarProxy#removeButton
+     * @property {string} name
+     */
     Q_INVOKABLE void removeButton(const QVariant& name);
 };
 
 Q_DECLARE_METATYPE(ToolbarProxy*);
 
+/**jsdoc
+ * @namespace Toolbars
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ */
 class ToolbarScriptingInterface : public QObject, public Dependency {
     Q_OBJECT
 public:
+
+    /**jsdoc
+     * @function Toolbars.getToolbar
+     * @param {string} toolbarID
+     * @returns {ToolbarProxy}
+     */
     Q_INVOKABLE ToolbarProxy* getToolbar(const QString& toolbarId);
 };