Mark the QtWaylandCompositor API as \preliminary

Change-Id: I85e3a6dd98496005c63a88bc0218bc94301692ba
Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>

16 files changed, 30 insertions, 1 deletions

diff --git a/src/compositor/compositor_api/qwaylandbufferref.cpp b/src/compositor/compositor_api/qwaylandbufferref.cpp
index faff48560..929503b4f 100644
--- a/src/compositor/compositor_api/qwaylandbufferref.cpp
+++ b/src/compositor/compositor_api/qwaylandbufferref.cpp
@@ -55,6 +55,7 @@ public:
 /*!
  * \class QWaylandBufferRef
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief A class which holds a reference to a surface buffer
  *
  * This class can be used to reference a surface buffer. As long as a reference
diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp
index 65f1d6349..d2da470a4 100644
--- a/src/compositor/compositor_api/qwaylandclient.cpp
+++ b/src/compositor/compositor_api/qwaylandclient.cpp
@@ -87,6 +87,7 @@ public:
 /*!
  * \qmltype WaylandClient
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief A client connecting to the WaylandCompositor.
  *
  * This type represents a client connecting to the compositor using the Wayland protocol.
@@ -96,6 +97,7 @@ public:
 /*!
  * \class QWaylandClient
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief A client connecting to the QWaylandCompositor.
  *
  * This class corresponds to a client connecting to the compositor using the Wayland protocol.
diff --git a/src/compositor/compositor_api/qwaylandcompositor.cpp b/src/compositor/compositor_api/qwaylandcompositor.cpp
index 9bc4f582b..696ee772f 100644
--- a/src/compositor/compositor_api/qwaylandcompositor.cpp
+++ b/src/compositor/compositor_api/qwaylandcompositor.cpp
@@ -406,6 +406,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration()
 /*!
   \qmltype WaylandCompositor
   \inqmlmodule QtWayland.Compositor
+  \preliminary
   \brief Type managing the Wayland display server.
 
   The WaylandCompositor manages the connections to the clients, as well as the different
@@ -424,6 +425,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration()
 /*!
    \class QWaylandCompositor
    \inmodule QtWaylandCompositor
+   \preliminary
    \brief Class managing the Wayland display server.
 
    The QWaylandCompositor manages the connections to the clients, as well as the different \l{QWaylandOutput}{outputs}
diff --git a/src/compositor/compositor_api/qwaylandinput.cpp b/src/compositor/compositor_api/qwaylandinput.cpp
index ad6cb2369..09c02bc48 100644
--- a/src/compositor/compositor_api/qwaylandinput.cpp
+++ b/src/compositor/compositor_api/qwaylandinput.cpp
@@ -151,6 +151,7 @@ QWaylandKeymap::QWaylandKeymap(const QString &layout, const QString &variant, co
 /*!
  * \class QWaylandInputDevice
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief The QWaylandInputDevice class provides access to keyboard, mouse and touch input.
  *
  * The QWaylandInputDevice provides access to different types of user input and maintains
diff --git a/src/compositor/compositor_api/qwaylandkeyboard.cpp b/src/compositor/compositor_api/qwaylandkeyboard.cpp
index caf2c9255..e6ba64ed5 100644
--- a/src/compositor/compositor_api/qwaylandkeyboard.cpp
+++ b/src/compositor/compositor_api/qwaylandkeyboard.cpp
@@ -381,6 +381,7 @@ void QWaylandKeyboardPrivate::sendRepeatInfo()
 /*!
  * \class QWaylandKeyboard
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief The QWaylandKeyboard class provides access to a keyboard device.
  *
  * This class provides access to the keyboard device in a QWaylandInputDevice. It corresponds to
diff --git a/src/compositor/compositor_api/qwaylandoutput.cpp b/src/compositor/compositor_api/qwaylandoutput.cpp
index d97ea04ef..65bac3352 100644
--- a/src/compositor/compositor_api/qwaylandoutput.cpp
+++ b/src/compositor/compositor_api/qwaylandoutput.cpp
@@ -189,6 +189,7 @@ QWaylandOutput::QWaylandOutput()
 /*!
    \qmltype WaylandOutput
    \inqmlmodule QtWayland.Compositor
+   \preliminary
    \brief Type providing access to a displayable area managed by the compositor.
 
    The WaylandOutput manages a rectangular part of the compositor's geometry that
@@ -201,6 +202,7 @@ QWaylandOutput::QWaylandOutput()
 /*!
    \class QWaylandOutput
    \inmodule QtWaylandCompositor
+   \preliminary
    \brief The QWaylandOutput class provides access to a displayable area managed by the compositor.
 
    The QWaylandOutput manages a rectangular part of the compositor's geometry that
diff --git a/src/compositor/compositor_api/qwaylandpointer.cpp b/src/compositor/compositor_api/qwaylandpointer.cpp
index a789c4c8c..da08e339e 100644
--- a/src/compositor/compositor_api/qwaylandpointer.cpp
+++ b/src/compositor/compositor_api/qwaylandpointer.cpp
@@ -94,6 +94,7 @@ void QWaylandPointerPrivate::pointer_set_cursor(wl_pointer::Resource *resource,
 /*!
  * \class QWaylandPointer
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief The QWaylandPointer class provides access to a pointer device.
  *
  * This class provides access to the pointer device in a QWaylandInputDevice. It corresponds to
diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp
index 7a044b855..9fa81cfb2 100644
--- a/src/compositor/compositor_api/qwaylandquickitem.cpp
+++ b/src/compositor/compositor_api/qwaylandquickitem.cpp
@@ -293,6 +293,7 @@ private:
 /*!
  * \qmltype WaylandQuickItem
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief A Qt Quick item representing a WaylandView.
  *
  * When writing a WaylandCompositor in Qt Quick, this type can be used to display a
@@ -303,6 +304,7 @@ private:
 /*!
  * \class QWaylandQuickItem
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief A Qt Quick item representing a QWaylandView.
  *
  * When writing a QWaylandCompositor in Qt Quick, this class can be used to display a
diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp
index ea4c4672e..85d1c7aa0 100644
--- a/src/compositor/compositor_api/qwaylandsurface.cpp
+++ b/src/compositor/compositor_api/qwaylandsurface.cpp
@@ -377,6 +377,7 @@ QtWayland::SurfaceBuffer *QWaylandSurfacePrivate::createSurfaceBuffer(struct ::w
 /*!
  * \qmltype WaylandSurface
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief A rectangular area which is displayed on an output device.
  *
  * This type encapsulates a rectangular area of pixels that is displayed on an output device. It
@@ -386,6 +387,7 @@ QtWayland::SurfaceBuffer *QWaylandSurfacePrivate::createSurfaceBuffer(struct ::w
 /*!
  * \class QWaylandSurface
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief A rectangular area which is displayed on an output device.
  *
  * This class encapsulates a rectangular area of pixels that is displayed on an output device. It
diff --git a/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp b/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp
index ab3342269..4e61e7f8a 100644
--- a/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp
+++ b/src/compositor/compositor_api/qwaylandsurfacegrabber.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \class QWaylandSurfaceGrabber
     \inmodule QtWaylandCompositor
-    \since 5.7
+    \preliminary
     \brief The QWaylandSurfaceGrabber class allows to read the content of a QWaylandSurface
 
     Sometimes it is needed to get the contents of a surface, for example to provide a screenshot
diff --git a/src/compositor/compositor_api/qwaylandtouch.cpp b/src/compositor/compositor_api/qwaylandtouch.cpp
index 058bedfa0..63b0f84ea 100644
--- a/src/compositor/compositor_api/qwaylandtouch.cpp
+++ b/src/compositor/compositor_api/qwaylandtouch.cpp
@@ -105,6 +105,7 @@ void QWaylandTouchPrivate::sendMotion(uint32_t time, int touch_id, const QPointF
 /*!
  * \class QWaylandTouch
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief The QWaylandTouch class provides access to a touch device.
  *
  * This class provides access to the touch device in a QWaylandInputDevice. It corresponds to
diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp
index dd27308ad..793dcf202 100644
--- a/src/compositor/compositor_api/qwaylandview.cpp
+++ b/src/compositor/compositor_api/qwaylandview.cpp
@@ -59,6 +59,7 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface)
 /*!
  * \qmltype WaylandView
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief Represents a view of a surface on an output.
  *
  * The WaylandView corresponds to the presentation of a surface on a specific output, managing
@@ -68,6 +69,7 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface)
 /*!
  * \class QWaylandView
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief Represents a view of a surface on an output.
  *
  * The WaylandView corresponds to the presentation of a surface on a specific output, managing
diff --git a/src/compositor/extensions/qwaylandquickwlshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickwlshellsurfaceitem.cpp
index a0f1538a7..21b5c75ad 100644
--- a/src/compositor/extensions/qwaylandquickwlshellsurfaceitem.cpp
+++ b/src/compositor/extensions/qwaylandquickwlshellsurfaceitem.cpp
@@ -45,6 +45,8 @@ QT_BEGIN_NAMESPACE
 /*!
  * \qmltype WlShellSurfaceItem
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
+ * \preliminary
  * \brief An item representing a WlShellSurface.
  *
  * This type can be used to render wl_shell_surfaces as part of a Qt Quick scene.
@@ -54,6 +56,8 @@ QT_BEGIN_NAMESPACE
 /*!
  * \class QWaylandQuickWlShellSurfaceItem
  * \inmodule QtWaylandCompositor
+ * \preliminary
+ * \preliminary
  * \brief A Qt Quick item for QWaylandWlShellSurface.
  *
  * This class can be used to create Qt Quick items representing wl_shell_surfaces.
diff --git a/src/compositor/extensions/qwaylandquickxdgsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickxdgsurfaceitem.cpp
index f4057e1b7..e5d4cdbc1 100644
--- a/src/compositor/extensions/qwaylandquickxdgsurfaceitem.cpp
+++ b/src/compositor/extensions/qwaylandquickxdgsurfaceitem.cpp
@@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE
 /*!
  * \qmltype XdgSurfaceItem
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief An item representing a XdgSurface.
  *
  * This type can be used to render xdg surfaces as part of a Qt Quick scene.
@@ -54,6 +55,7 @@ QT_BEGIN_NAMESPACE
 /*!
  * \class QWaylandQuickXdgSurfaceItem
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief A Qt Quick item for QWaylandXdgSurface.
  *
  * This class can be used to create Qt Quick items representing xdg surfaces.
diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp
index 817a01b9e..6953f72b6 100644
--- a/src/compositor/extensions/qwaylandwlshell.cpp
+++ b/src/compositor/extensions/qwaylandwlshell.cpp
@@ -240,6 +240,7 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource,
 /*!
  * \qmltype WlShell
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief Extension for desktop-style user interfaces.
  *
  * The WlShell extension provides a way to assiociate a \l{ShellSurface}
@@ -265,6 +266,7 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource,
 /*!
  * \class QWaylandWlShell
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief Extension for desktop-style user interfaces.
  *
  * The QWaylandWlShell extension provides a way to assiociate a QWaylandWlShellSurface with
@@ -341,6 +343,7 @@ QByteArray QWaylandWlShell::interfaceName()
 /*!
  * \qmltype WlShellSurface
  * \inqmlmodule QtWayland.Compositor
+ * \preliminary
  * \brief A wl_shell_surface providing desktop-style compositor-specific features to a surface.
  *
  * This type is part of the \l{WlShell} extension and provides a way to extend
@@ -353,6 +356,7 @@ QByteArray QWaylandWlShell::interfaceName()
 /*!
  * \class QWaylandWlShellSurface
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief A shell surface providing desktop-style compositor-specific features to a surface.
  *
  * This class is part of the QWaylandWlShell extension and provides a way to extend
diff --git a/src/compositor/extensions/qwaylandxdgshell.cpp b/src/compositor/extensions/qwaylandxdgshell.cpp
index bd25e3ca3..c4371339b 100644
--- a/src/compositor/extensions/qwaylandxdgshell.cpp
+++ b/src/compositor/extensions/qwaylandxdgshell.cpp
@@ -577,6 +577,7 @@ void QWaylandXdgShell::handleFocusChanged(QWaylandSurface *newSurface, QWaylandS
 /*!
  * \class QWaylandXdgSurface
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief An xdg surface providing desktop-style compositor-specific features to a surface.
  *
  * This class is part of the QWaylandXdgShell extension and provides a way to
@@ -915,6 +916,7 @@ uint QWaylandXdgSurface::requestResizing(const QSize &maxSize)
 /*!
  * \class QWaylandXdgPopup
  * \inmodule QtWaylandCompositor
+ * \preliminary
  * \brief An xdg popup providing menus for an xdg surface
  *
  * This class is part of the QWaylandXdgShell extension and provides a way to