From 71355840b992d2b34c2d593e35588a9f3b71ef2d Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Mon, 14 May 2018 09:57:35 +1200
Subject: [PATCH] Expand OverlayWindow and OverlayWebWindow JSDoc stubs

---
 libraries/ui/src/QmlWebWindowClass.h |  2 +-
 libraries/ui/src/QmlWindowClass.cpp  |  8 ++++++++
 libraries/ui/src/QmlWindowClass.h    | 21 +++++++++++++++++++--
 3 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/libraries/ui/src/QmlWebWindowClass.h b/libraries/ui/src/QmlWebWindowClass.h
index 95ac2eac4a..c35a6bab87 100644
--- a/libraries/ui/src/QmlWebWindowClass.h
+++ b/libraries/ui/src/QmlWebWindowClass.h
@@ -14,7 +14,7 @@
 /**jsdoc
  * @class OverlayWebWindow
  * @augments OverlayWindow
- * @param {object} [properties=null]
+ * @param {OverlayWindow.Properties} [properties=null]
  *
  * @hifi-interface
  * @hifi-client-en
diff --git a/libraries/ui/src/QmlWindowClass.cpp b/libraries/ui/src/QmlWindowClass.cpp
index 02c9707d95..64fa27c8c6 100644
--- a/libraries/ui/src/QmlWindowClass.cpp
+++ b/libraries/ui/src/QmlWindowClass.cpp
@@ -87,6 +87,14 @@ QmlWindowClass::QmlWindowClass() {
 
 }
 
+/**jsdoc
+ * @typedef {object} OverlayWindow.Properties
+ * @property {string} title
+ * @property {string} source
+ * @property {number} width
+ * @property {number} height
+ * @property {boolean} visible
+ */
 void QmlWindowClass::initQml(QVariantMap properties) {
     auto offscreenUi = DependencyManager::get<OffscreenUi>();
     _source = properties[SOURCE_PROPERTY].toString();
diff --git a/libraries/ui/src/QmlWindowClass.h b/libraries/ui/src/QmlWindowClass.h
index 34b4d2f7c0..2b01c028ea 100644
--- a/libraries/ui/src/QmlWindowClass.h
+++ b/libraries/ui/src/QmlWindowClass.h
@@ -21,7 +21,7 @@ class QScriptContext;
 
 /**jsdoc
  * @class OverlayWindow
- * @param {object} [properties=null]
+ * @param {OverlayWindow.Properties} [properties=null]
  *
  * @hifi-interface
  * @hifi-client-en
@@ -45,7 +45,7 @@ public:
 
     /**jsdoc
      * @function OverlayWindow.initQml
-     * @param {object} properties
+     * @param {OverlayWindow.Properties} properties
      */
     Q_INVOKABLE virtual void initQml(QVariantMap properties);
 
@@ -220,8 +220,25 @@ signals:
     void webEventReceived(const QVariant& message);
 
 protected slots:
+
+    /**jsdoc
+     * @function OverlayWindow.hasMoved
+     * @param {Vec2} position
+     * @returns {Signal}
+     */
     void hasMoved(QVector2D);
+
+    /**jsdoc
+     * @function OverlayWindow.hasClosed
+     * @returns {Signal}
+     */
     void hasClosed();
+
+    /**jsdoc
+     * @function OverlayWindow.qmlToScript
+     * @param {object} message
+     * @returns {Signal}
+     */
     void qmlToScript(const QVariant& message);
 
 protected: