From 59c8598958959de943a0782093f020ae1c348edf Mon Sep 17 00:00:00 2001 From: Johan Klokkhammer Helsing Date: Mon, 3 Oct 2016 13:01:40 +0200 Subject: Documentation: Remove tech preview status Remove "preliminary" and add "since 5.8". Also remove notice from readme about the API being in tech preview. Change-Id: I4ef1ffa4e23661f5a1e28c9e3207678be5b0435c Reviewed-by: Pier Luigi Fiorini Reviewed-by: Paul Olav Tvete --- README | 5 ----- src/compositor/compositor_api/qwaylandbufferref.cpp | 2 +- src/compositor/compositor_api/qwaylandclient.cpp | 4 ++-- src/compositor/compositor_api/qwaylandcompositor.cpp | 4 ++-- src/compositor/compositor_api/qwaylandkeyboard.cpp | 2 +- src/compositor/compositor_api/qwaylandoutput.cpp | 4 ++-- src/compositor/compositor_api/qwaylandpointer.cpp | 2 +- src/compositor/compositor_api/qwaylandquickitem.cpp | 4 ++-- src/compositor/compositor_api/qwaylandseat.cpp | 2 +- src/compositor/compositor_api/qwaylandsurface.cpp | 4 ++-- src/compositor/compositor_api/qwaylandsurfacegrabber.cpp | 2 +- src/compositor/compositor_api/qwaylandtouch.cpp | 2 +- src/compositor/compositor_api/qwaylandview.cpp | 4 ++-- src/compositor/extensions/qwaylandivisurface.cpp | 2 +- src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp | 4 ++-- src/compositor/extensions/qwaylandwlshell.cpp | 8 ++++---- src/compositor/extensions/qwaylandxdgshellv5.cpp | 4 ++-- 17 files changed, 27 insertions(+), 32 deletions(-) diff --git a/README b/README index 3121878ca..7d9ed16bd 100644 --- a/README +++ b/README @@ -8,11 +8,6 @@ Wayland platform plugin: QtWaylandCompositor API: Enables the creation of Wayland compositors using Qt and QtQuick. -Please note that QtWaylandCompositor and the QtWaylandClientExtension are -currently in tech preview. This means that all APIs in the QtWayland module are -preliminary and subject to change. The Wayland platform plugin remains officially -supported. - To build the QtWayland module you need the external dependencies: xkbcommon 0.2.0 - http://xkbcommon.org/ wayland 1.6.0 - http://wayland.freedesktop.org/ diff --git a/src/compositor/compositor_api/qwaylandbufferref.cpp b/src/compositor/compositor_api/qwaylandbufferref.cpp index 90b3f1c46..6f175de95 100644 --- a/src/compositor/compositor_api/qwaylandbufferref.cpp +++ b/src/compositor/compositor_api/qwaylandbufferref.cpp @@ -55,7 +55,7 @@ public: /*! * \class QWaylandBufferRef * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandBufferRef class holds the 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 23c3745d7..eb12fa3d8 100644 --- a/src/compositor/compositor_api/qwaylandclient.cpp +++ b/src/compositor/compositor_api/qwaylandclient.cpp @@ -87,7 +87,7 @@ public: /*! * \qmltype WaylandClient * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief Represents a client connecting to the WaylandCompositor. * * This type represents a client connecting to the compositor using the Wayland protocol. @@ -97,7 +97,7 @@ public: /*! * \class QWaylandClient * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandClient class represents 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 79a62a1f2..bcee61d8b 100644 --- a/src/compositor/compositor_api/qwaylandcompositor.cpp +++ b/src/compositor/compositor_api/qwaylandcompositor.cpp @@ -424,7 +424,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration() /*! \qmltype WaylandCompositor \inqmlmodule QtWayland.Compositor - \preliminary + \since 5.8 \brief Manages the Wayland display server. The WaylandCompositor manages the connections to the clients, as well as the different @@ -443,7 +443,7 @@ void QWaylandCompositorPrivate::loadServerBufferIntegration() /*! \class QWaylandCompositor \inmodule QtWaylandCompositor - \preliminary + \since 5.8 \brief The QWaylandCompositor class manages 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/qwaylandkeyboard.cpp b/src/compositor/compositor_api/qwaylandkeyboard.cpp index 780c13144..5bbec0a45 100644 --- a/src/compositor/compositor_api/qwaylandkeyboard.cpp +++ b/src/compositor/compositor_api/qwaylandkeyboard.cpp @@ -383,7 +383,7 @@ void QWaylandKeyboardPrivate::sendRepeatInfo() /*! * \class QWaylandKeyboard * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandKeyboard class represents a keyboard device. * * This class provides access to the keyboard device in a QWaylandSeat. It corresponds to diff --git a/src/compositor/compositor_api/qwaylandoutput.cpp b/src/compositor/compositor_api/qwaylandoutput.cpp index c34080b36..40cd9798c 100644 --- a/src/compositor/compositor_api/qwaylandoutput.cpp +++ b/src/compositor/compositor_api/qwaylandoutput.cpp @@ -189,7 +189,7 @@ QWaylandOutput::QWaylandOutput() /*! \qmltype WaylandOutput \inqmlmodule QtWayland.Compositor - \preliminary + \since 5.8 \brief Provides access to a displayable area managed by the compositor. The WaylandOutput manages a rectangular area within bounds of the compositor's @@ -202,7 +202,7 @@ QWaylandOutput::QWaylandOutput() /*! \class QWaylandOutput \inmodule QtWaylandCompositor - \preliminary + \since 5.8 \brief The QWaylandOutput class represents a displayable area managed by the compositor. The QWaylandOutput manages a rectangular area within bounds of the compositor's diff --git a/src/compositor/compositor_api/qwaylandpointer.cpp b/src/compositor/compositor_api/qwaylandpointer.cpp index 5581a5c10..2ff56a1e6 100644 --- a/src/compositor/compositor_api/qwaylandpointer.cpp +++ b/src/compositor/compositor_api/qwaylandpointer.cpp @@ -94,7 +94,7 @@ void QWaylandPointerPrivate::pointer_set_cursor(wl_pointer::Resource *resource, /*! * \class QWaylandPointer * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandPointer class represents a pointer device. * * This class provides access to the pointer device in a QWaylandSeat. It corresponds to diff --git a/src/compositor/compositor_api/qwaylandquickitem.cpp b/src/compositor/compositor_api/qwaylandquickitem.cpp index 3e8d4b136..d722cc498 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -314,7 +314,7 @@ private: /*! * \qmltype WaylandQuickItem * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief Provides a Qt Quick item that represents a WaylandView. * * Qt Quick-based Wayland compositors can use this type to display a client's @@ -325,7 +325,7 @@ private: /*! * \class QWaylandQuickItem * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandQuickItem class provides 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/qwaylandseat.cpp b/src/compositor/compositor_api/qwaylandseat.cpp index d096dff79..169d5de62 100644 --- a/src/compositor/compositor_api/qwaylandseat.cpp +++ b/src/compositor/compositor_api/qwaylandseat.cpp @@ -143,7 +143,7 @@ void QWaylandSeatPrivate::seat_get_touch(wl_seat::Resource *resource, uint32_t i /*! * \class QWaylandSeat * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandSeat class provides access to keyboard, mouse, and touch input. * * The QWaylandSeat provides access to different types of user input and maintains diff --git a/src/compositor/compositor_api/qwaylandsurface.cpp b/src/compositor/compositor_api/qwaylandsurface.cpp index 2f4de5cfc..69d182812 100644 --- a/src/compositor/compositor_api/qwaylandsurface.cpp +++ b/src/compositor/compositor_api/qwaylandsurface.cpp @@ -348,7 +348,7 @@ QtWayland::ClientBuffer *QWaylandSurfacePrivate::getBuffer(struct ::wl_resource /*! * \qmltype WaylandSurface * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief Represents a rectangular area on an output device. * * This type encapsulates a rectangular area of pixels that is displayed on an output device. It @@ -358,7 +358,7 @@ QtWayland::ClientBuffer *QWaylandSurfacePrivate::getBuffer(struct ::wl_resource /*! * \class QWaylandSurface * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandSurface class represents a rectangular area 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 f751a3d96..58a8b7be6 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 - \preliminary + \since 5.8 \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 9e354605b..168edc496 100644 --- a/src/compositor/compositor_api/qwaylandtouch.cpp +++ b/src/compositor/compositor_api/qwaylandtouch.cpp @@ -99,7 +99,7 @@ void QWaylandTouchPrivate::sendMotion(QWaylandClient *client, uint32_t time, int /*! * \class QWaylandTouch * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandTouch class provides access to a touch device. * * This class provides access to the touch device in a QWaylandSeat. It corresponds to diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp index 850503847..ef9e43a3d 100644 --- a/src/compositor/compositor_api/qwaylandview.cpp +++ b/src/compositor/compositor_api/qwaylandview.cpp @@ -59,7 +59,7 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface) /*! * \qmltype WaylandView * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief Represents a view of a surface on an output. * * The WaylandView corresponds to the presentation of a surface on a specific @@ -70,7 +70,7 @@ void QWaylandViewPrivate::markSurfaceAsDestroyed(QWaylandSurface *surface) /*! * \class QWaylandView * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandView class represents a view of a surface on an output. * * The QWaylandView corresponds to the presentation of a surface on a specific diff --git a/src/compositor/extensions/qwaylandivisurface.cpp b/src/compositor/extensions/qwaylandivisurface.cpp index 2de407e11..4708243a6 100644 --- a/src/compositor/extensions/qwaylandivisurface.cpp +++ b/src/compositor/extensions/qwaylandivisurface.cpp @@ -47,7 +47,7 @@ QWaylandSurfaceRole QWaylandIviSurfacePrivate::s_role("ivi_surface"); /*! * \class QWaylandIviSurface * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandIviSurface class provides a simple way to identify and resize a surface. * * This class is part of the QWaylandIviApplication extension and provides a way to diff --git a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp index 9cb65fbef..f6a88e434 100644 --- a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp +++ b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp @@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE /*! * \qmltype ShellSurfaceItem * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief A Qt Quick item type representing a WlShellSurface. * * This type is used to render \c wl_shell or \c xdg_shell surfaces as part of a Qt Quick @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE /*! * \class QWaylandQuickShellSurfaceItem * \inmodule QtWaylandCompositor - * \preliminary + * \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 diff --git a/src/compositor/extensions/qwaylandwlshell.cpp b/src/compositor/extensions/qwaylandwlshell.cpp index 2fca88fef..3145c6646 100644 --- a/src/compositor/extensions/qwaylandwlshell.cpp +++ b/src/compositor/extensions/qwaylandwlshell.cpp @@ -258,7 +258,7 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource, /*! * \qmltype WlShell * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief Provides an extension for desktop-style user interfaces. * * The WlShell extension provides a way to assiociate a ShellSurface @@ -284,7 +284,7 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource, /*! * \class QWaylandWlShell * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandWlShell class is an extension for desktop-style user interfaces. * * The QWaylandWlShell extension provides a way to assiociate a QWaylandWlShellSurface with @@ -406,7 +406,7 @@ QByteArray QWaylandWlShell::interfaceName() /*! * \qmltype WlShellSurface * \inqmlmodule QtWayland.Compositor - * \preliminary + * \since 5.8 * \brief Provides a \c wl_shell_surface that offers desktop-style compositor-specific features to a surface. * * This type is part of the \l{WlShell} extension and provides a way to extend @@ -419,7 +419,7 @@ QByteArray QWaylandWlShell::interfaceName() /*! * \class QWaylandWlShellSurface * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandWlShellSurface class provides 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/qwaylandxdgshellv5.cpp b/src/compositor/extensions/qwaylandxdgshellv5.cpp index 88d7a1b04..b73b84d7a 100644 --- a/src/compositor/extensions/qwaylandxdgshellv5.cpp +++ b/src/compositor/extensions/qwaylandxdgshellv5.cpp @@ -623,7 +623,7 @@ void QWaylandXdgShellV5::handleFocusChanged(QWaylandSurface *newSurface, QWaylan /*! * \class QWaylandXdgSurfaceV5 * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandXdgSurfaceV5 class provides desktop-style compositor-specific features to an xdg surface. * * This class is part of the QWaylandXdgShellV5 extension and provides a way to @@ -1019,7 +1019,7 @@ QWaylandQuickShellIntegration *QWaylandXdgSurfaceV5::createIntegration(QWaylandQ /*! * \class QWaylandXdgPopupV5 * \inmodule QtWaylandCompositor - * \preliminary + * \since 5.8 * \brief The QWaylandXdgPopupV5 class provides menus for an xdg surface * * This class is part of the QWaylandXdgShellV5 extension and provides a way to -- cgit v1.2.3