Add QML API and documentation for ivi-application

Change-Id: I65504503f07477b05f7e645ee61544e62e728bdc
Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>

1 files changed, 16 insertions, 0 deletions

diff --git a/src/compositor/extensions/qwaylandiviapplication.cpp b/src/compositor/extensions/qwaylandiviapplication.cpp
index c3eea08d7..30784e4ec 100644
--- a/src/compositor/extensions/qwaylandiviapplication.cpp
+++ b/src/compositor/extensions/qwaylandiviapplication.cpp
@@ -91,6 +91,15 @@ QByteArray QWaylandIviApplication::interfaceName()
 }
 
 /*!
+ * \qmlsignal void QtWaylandCompositor::IviApplication::iviSurfaceRequested(object surface, int iviId, object resource)
+ *
+ * This signal is emitted when the client has requested an \c ivi_surface to be associated
+ * with \a surface, which is identified by \a id. The handler for this signal is
+ * expected to create the ivi surface and initialize it within the scope of the
+ * signal emission. If no ivi surface is created, a default one will be created instead.
+ */
+
+/*!
  * \fn void QWaylandWlShell::iviSurfaceRequested(QWaylandSurface *surface, uint iviId, const QWaylandResource &resource)
  *
  * This signal is emitted when the client has requested an \c ivi_surface to be associated
@@ -100,6 +109,13 @@ QByteArray QWaylandIviApplication::interfaceName()
  */
 
 /*!
+ * \qmlsignal void QtWaylandCompositor::IviApplication::iviSurfaceCreated(object *iviSurface)
+ *
+ * This signal is emitted when an IviSurface has been created. The supplied \a iviSurface is
+ * most commonly used to instantiate a ShellSurfaceItem.
+ */
+
+/*!
  * \fn void QtWaylandCompositor::IviApplication::iviSurfaceCreated(QWaylandIviSurface *iviSurface)
  *
  * This signal is emitted when an IviSurface has been created.