summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@qt.io>2017-08-08 11:39:35 +0200
committerJohan Helsing <johan.helsing@qt.io>2017-10-03 08:35:56 +0000
commit186eddb7fba58a64e8ce2a3d27847c45ae3b3ab0 (patch)
tree04c96a9ffeb60bf5f67495ce314c30ccd1f6f83f /src
parentdd584b2cf2060434b4bfca7940905612cfd4a2a9 (diff)
Update documentation for QWaylandQuickShellSurfaceItem
Change-Id: I80b4f078d63ac32d9ce6d91fc46f0b9d9d7d7146 Reviewed-by: Paolo Angelelli <paolo.angelelli@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
index 9f6510476..e5443d468 100644
--- a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
+++ b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
@@ -50,12 +50,12 @@ QT_BEGIN_NAMESPACE
* \inherits WaylandQuickItem
* \inqmlmodule QtWayland.Compositor
* \since 5.8
- * \brief A Qt Quick item type representing a WlShellSurface.
+ * \brief A Qt Quick item type for displaying and interacting with a ShellSurface.
*
- * This type is used to render \c wl_shell or \c xdg_shell surfaces as part of a Qt Quick
- * scene. It handles moving and resizing triggered by clicking on the window decorations.
+ * This type is used to render \c wl_shell, \c xdg_shell or \c ivi_application surfaces as part of
+ * a Qt Quick scene. It handles moving and resizing triggered by clicking on the window decorations.
*
- * \sa WaylandQuickItem
+ * \sa WaylandQuickItem, WlShellSurface, XdgSurfaceV5, IviSurface
*/
/*!
@@ -64,10 +64,10 @@ QT_BEGIN_NAMESPACE
* \since 5.8
* \brief The QWaylandQuickShellSurfaceItem class provides a Qt Quick item that represents a QWaylandShellSurface.
*
- * This class is used to render \c wl_shell or \c xdg_shell surfaces as part of a Qt Quick
- * scene. It handles moving and resizing triggered by clicking on the window decorations.
+ * This class is used to render \c wl_shell, \c xdg_shell or \c ivi_application surfaces as part of
+ * a Qt Quick scene. It handles moving and resizing triggered by clicking on the window decorations.
*
- * \sa QWaylandQuickItem
+ * \sa QWaylandQuickItem, QWaylandWlShellSurface, QWaylandXdgSurfaceV5, QWaylandIviSurface
*/
/*!