summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@qt.io>2017-09-26 11:54:27 +0200
committerJohan Helsing <johan.helsing@qt.io>2017-10-03 14:08:04 +0000
commita81fc596a3cbcc07396be1c0284f1ee8aa44ff8c (patch)
tree80fccda75de741c64d4553eb468fcff7237fb555
parentff22565d0f76a422d0a6299d56e47045b8c18a38 (diff)
Add missing documentation for XdgShellV6
Change-Id: Ifc7682614ee4e2691dface73ceace20fd4f6effa Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r--src/compositor/extensions/qwaylandxdgshellv6.cpp39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/compositor/extensions/qwaylandxdgshellv6.cpp b/src/compositor/extensions/qwaylandxdgshellv6.cpp
index ba8ca63d..4b1d46b8 100644
--- a/src/compositor/extensions/qwaylandxdgshellv6.cpp
+++ b/src/compositor/extensions/qwaylandxdgshellv6.cpp
@@ -146,6 +146,45 @@ void QWaylandXdgShellV6Private::zxdg_shell_v6_pong(Resource *resource, uint32_t
}
/*!
+ * \qmltype XdgShellV6
+ * \inqmlmodule QtWayland.Compositor
+ * \since 5.10
+ * \brief Provides an extension for desktop-style user interfaces.
+ *
+ * The XdgShellV6 extension provides a way to associate a XdgToplevelV6 or XdgPopupV6
+ * with a regular Wayland surface. Using the XdgToplevelV6 interface, the client
+ * can request that the surface is resized, moved, and so on.
+ *
+ * XdgShellV6 corresponds to the Wayland interface, \c zxdg_shell_v6.
+ *
+ * To provide the functionality of the shell extension in a compositor, create
+ * an instance of the XdgShellV6 component and add it to the list of extensions
+ * supported by the compositor:
+ * \code
+ * import QtWayland.Compositor 1.1
+ *
+ * WaylandCompositor {
+ * XdgShellV6 {
+ * // ...
+ * }
+ * }
+ * \endcode
+ */
+
+/*!
+ * \class QWaylandXdgShellV6
+ * \inmodule QtWaylandCompositor
+ * \since 5.10
+ * \brief The QWaylandXdgShellV6 class is an extension for desktop-style user interfaces.
+ *
+ * The QWaylandXdgShellV6 extension provides a way to associate a QWaylandXdgToplevelV6 or
+ * QWaylandXdgPopupV6 with a regular Wayland surface. Using the QWaylandXdgToplevelV6 interface,
+ * the client can request that the surface is resized, moved, and so on.
+ *
+ * QWaylandXdgShellV6 corresponds to the Wayland interface, \c zxdg_shell_v6.
+ */
+
+/*!
* Constructs a QWaylandXdgShellV6 object.
*/
QWaylandXdgShellV6::QWaylandXdgShellV6()