Expand OverlayWindow and OverlayWebWindow JSDoc stubs

This commit is contained in:
David Rowe 2018-05-14 09:57:35 +12:00
parent cad5b3fb15
commit 71355840b9
3 changed files with 28 additions and 3 deletions

View file

@ -14,7 +14,7 @@
/**jsdoc
* @class OverlayWebWindow
* @augments OverlayWindow
* @param {object} [properties=null]
* @param {OverlayWindow.Properties} [properties=null]
*
* @hifi-interface
* @hifi-client-en

View file

@ -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();

View file

@ -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: