Docs: Add "instantiates" keywords

Document what the corresponding C++ class for any given QML item is,
like it's done in Qt Declarative.

Change-Id: I015565f88cb457f1e73dd7c2c54edff3505db395
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
(cherry picked from commit a04decb6a85ef254ec48842e7551a2920de6a714)
Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>

16 files changed, 20 insertions, 0 deletions

diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp
index 51f46e0b..cea02578 100644
--- a/src/compositor/compositor_api/qwaylandclient.cpp
+++ b/src/compositor/compositor_api/qwaylandclient.cpp
@@ -79,6 +79,7 @@ public:
 
 /*!
  * \qmltype WaylandClient
+ * \instantiates QWaylandClient
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
  * \brief Represents a client connecting to the WaylandCompositor.
diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp
index 23bdbb15..483bae40 100644
--- a/src/compositor/compositor_api/qwaylandcompositor.cpp
+++ b/src/compositor/compositor_api/qwaylandcompositor.cpp
@@ -451,6 +451,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration()
 
 /*!
   \qmltype WaylandCompositor
+  \instantiates QWaylandCompositor
   \inqmlmodule QtWayland.Compositor
   \since 5.8
   \brief Manages the Wayland display server.
diff --git a/src/compositor/compositor_api/qwaylandoutput.cpp b/src/compositor/compositor_api/qwaylandoutput.cpp
index 9cde6f97..5ca7a4e8 100644
--- a/src/compositor/compositor_api/qwaylandoutput.cpp
+++ b/src/compositor/compositor_api/qwaylandoutput.cpp
@@ -249,6 +249,7 @@ QWaylandOutput::QWaylandOutput()
 
 /*!
    \qmltype WaylandOutput
+   \instantiates QWaylandOutput
    \inqmlmodule QtWayland.Compositor
    \since 5.8
    \brief Provides access to a displayable area managed by the compositor.
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp
index 84f66a5c..b487fb30 100644
--- a/src/compositor/compositor_api/qwaylandquickitem.cpp
+++ b/src/compositor/compositor_api/qwaylandquickitem.cpp
@@ -319,6 +319,7 @@ private:
 
 /*!
  * \qmltype WaylandQuickItem
+ * \instantiates QWaylandQuickItem
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
  * \brief Provides a Qt Quick item that represents a WaylandView.
diff --git a/src/compositor/compositor_api/qwaylandseat.cpp b/src/compositor/compositor_api/qwaylandseat.cpp
index 88e80609..d11cbb92 100644
--- a/src/compositor/compositor_api/qwaylandseat.cpp
+++ b/src/compositor/compositor_api/qwaylandseat.cpp
@@ -136,6 +136,7 @@ void QWaylandSeatPrivate::seat_get_touch(wl_seat::Resource *resource, uint32_t i
 
 /*!
  * \qmltype WaylandSeat
+ * \instantiates QWaylandSeat
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
  * \brief Provides access to keyboard, mouse, and touch input.
diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp
index 0c055478..4fed76d3 100644
--- a/src/compositor/compositor_api/qwaylandsurface.cpp
+++ b/src/compositor/compositor_api/qwaylandsurface.cpp
@@ -335,6 +335,7 @@ QtWayland::ClientBuffer *QWaylandSurfacePrivate::getBuffer(struct ::wl_resource
 
 /*!
  * \qmltype WaylandSurface
+ * \instantiates QWaylandSurface
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
  * \brief Represents a rectangular area on an output device.
diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp
index caa1c666..b42db670 100644
--- a/src/compositor/compositor_api/qwaylandview.cpp
+++ b/src/compositor/compositor_api/qwaylandview.cpp
@@ -54,6 +54,7 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface)
 
 /*!
  * \qmltype WaylandView
+ * \instantiates QWaylandView
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
  * \brief Represents a view of a surface on an output.
diff --git a/src/compositor/extensions/qwaylandidleinhibitv1.cpp b/src/compositor/extensions/qwaylandidleinhibitv1.cpp
index 86444a6a..295c4814 100644
--- a/src/compositor/extensions/qwaylandidleinhibitv1.cpp
+++ b/src/compositor/extensions/qwaylandidleinhibitv1.cpp
@@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \qmltype IdleInhibitManagerV1
+    \instantiates QWaylandIdleInhibitManagerV1
     \inqmlmodule QtWayland.Compositor
     \since 5.14
     \brief Provides an extension that allows to inhibit the idle behavior of the compositor.
diff --git a/src/compositor/extensions/qwaylandiviapplication.cpp b/src/compositor/extensions/qwaylandiviapplication.cpp
index b6ddb983..61b42264 100644
--- a/src/compositor/extensions/qwaylandiviapplication.cpp
+++ b/src/compositor/extensions/qwaylandiviapplication.cpp
@@ -40,6 +40,7 @@ QT_BEGIN_NAMESPACE
 /*!
  * \qmltype IviApplication
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandIviApplication
  * \since 5.8
  * \brief Provides a shell extension for embedded-style user interfaces.
  *
diff --git a/src/compositor/extensions/qwaylandivisurface.cpp b/src/compositor/extensions/qwaylandivisurface.cpp
index e68077a4..0588e9bc 100644
--- a/src/compositor/extensions/qwaylandivisurface.cpp
+++ b/src/compositor/extensions/qwaylandivisurface.cpp
@@ -46,6 +46,7 @@ QWaylandSurfaceRole QWaylandIviSurfacePrivate::s_role("ivi_surface");
 /*!
  * \qmltype IviSurface
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandIviSurface
  * \since 5.8
  * \brief Provides a simple way to identify and resize a surface.
  *
diff --git a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
index 2196f8cd..eb6db414 100644
--- a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
+++ b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp
@@ -52,6 +52,7 @@ QWaylandQuickShellSurfaceItem *QWaylandQuickShellSurfaceItemPrivate::maybeCreate
 
 /*!
  * \qmltype ShellSurfaceItem
+ * \instantiates QWaylandQuickShellSurfaceItem
  * \inherits WaylandQuickItem
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
diff --git a/src/compositor/extensions/qwaylandshellsurface.cpp b/src/compositor/extensions/qwaylandshellsurface.cpp
index 42148c17..373a06cf 100644
--- a/src/compositor/extensions/qwaylandshellsurface.cpp
+++ b/src/compositor/extensions/qwaylandshellsurface.cpp
@@ -31,6 +31,7 @@
 
 /*!
  * \qmltype ShellSurface
+ * \instantiates QWaylandShellSurface
  * \inqmlmodule QtWayland.Compositor
  * \since 5.8
  * \brief Provides a common interface for surface roles specified by shell extensions.
diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp
index 11425765..7904a9e5 100644
--- a/src/compositor/extensions/qwaylandwlshell.cpp
+++ b/src/compositor/extensions/qwaylandwlshell.cpp
@@ -245,6 +245,7 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource,
 /*!
  * \qmltype WlShell
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandWlShell
  * \since 5.8
  * \brief Provides an extension for desktop-style user interfaces.
  *
@@ -414,6 +415,7 @@ QByteArray QWaylandWlShell::interfaceName()
 /*!
  * \qmltype WlShellSurface
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandWlShellSurface
  * \since 5.8
  * \brief Provides a \c wl_shell_surface that offers desktop-style compositor-specific features to a surface.
  *
diff --git a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp
index 037f78f5..e1c9e4b4 100644
--- a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp
+++ b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp
@@ -40,6 +40,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmltype XdgDecorationManagerV1
     \inqmlmodule QtWayland.Compositor
+    \instantiates QWaylandXdgDecorationManagerV1
     \since 5.12
     \brief Provides an extension for negotiation of server-side and client-side window decorations.
 
diff --git a/src/compositor/extensions/qwaylandxdgoutputv1.cpp b/src/compositor/extensions/qwaylandxdgoutputv1.cpp
index 954e7aaf..4c67ef7f 100644
--- a/src/compositor/extensions/qwaylandxdgoutputv1.cpp
+++ b/src/compositor/extensions/qwaylandxdgoutputv1.cpp
@@ -39,6 +39,7 @@ QT_BEGIN_NAMESPACE
 /*!
  * \qmltype XdgOutputManagerV1
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandXdgOutputManagerV1
  * \since 5.14
  * \brief Provides an extension for describing outputs in a desktop oriented fashion.
  *
diff --git a/src/compositor/extensions/qwaylandxdgshell.cpp b/src/compositor/extensions/qwaylandxdgshell.cpp
index c1b626bc..8137887c 100644
--- a/src/compositor/extensions/qwaylandxdgshell.cpp
+++ b/src/compositor/extensions/qwaylandxdgshell.cpp
@@ -135,6 +135,7 @@ void QWaylandXdgShellPrivate::xdg_wm_base_pong(Resource *resource, uint32_t seri
 /*!
  * \qmltype XdgShell
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandXdgShell
  * \since 5.12
  * \brief Provides an extension for desktop-style user interfaces.
  *
@@ -455,6 +456,7 @@ void QWaylandXdgSurfacePrivate::xdg_surface_set_window_geometry(QtWaylandServer:
 /*!
  * \qmltype XdgSurface
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandXdgSurface
  * \since 5.12
  * \brief XdgSurface provides desktop-style compositor-specific features to an xdg surface.
  *
@@ -704,6 +706,7 @@ QWaylandQuickShellIntegration *QWaylandXdgSurface::createIntegration(QWaylandQui
 /*!
  * \qmltype XdgToplevel
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandXdgToplevel
  * \since 5.12
  * \brief XdgToplevel represents the toplevel window specific parts of an xdg surface.
  *
@@ -1541,6 +1544,7 @@ void QWaylandXdgToplevelPrivate::xdg_toplevel_set_minimized(QtWaylandServer::xdg
 /*!
  * \qmltype XdgPopup
  * \inqmlmodule QtWayland.Compositor
+ * \instantiates QWaylandXdgPopup
  * \since 5.12
  * \brief XdgPopup represents the popup specific parts of and xdg surface.
  *