From aee5dbf01c24a1487847d996647b0c53f1f20e8b Mon Sep 17 00:00:00 2001 From: Eskil Abrahamsen Blomfeldt Date: Fri, 22 Apr 2022 09:10:20 +0200 Subject: doc: Add missing qml module landing pages When these are missing, external links to the contents of the modules break. Any \inqmlmodule should always have a corresponding \qmlmodule. Pick-to: 6.3 Fixes: QTBUG-102379 Change-Id: Id800e1ac3976957869f4a521f69f0190fb7eba5a Reviewed-by: Paul Olav Tvete --- .../qwaylandcompositoriviapplicationplugin.cpp | 19 ++++++++++++++++++ .../qwaylandcompositorpresentationtimeplugin.cpp | 22 +++++++++++++++++++++ .../qtshell/qwaylandqtshellplugin.cpp | 23 ++++++++++++++++++++++ .../wlshell/qwaylandcompositorwlshellplugin.cpp | 20 +++++++++++++++++++ .../xdgshell/qwaylandcompositorxdgshellplugin.cpp | 19 ++++++++++++++++++ 5 files changed, 103 insertions(+) diff --git a/src/imports/compositor-extensions/iviapplication/qwaylandcompositoriviapplicationplugin.cpp b/src/imports/compositor-extensions/iviapplication/qwaylandcompositoriviapplicationplugin.cpp index bcd5700a..94fe7b5c 100644 --- a/src/imports/compositor-extensions/iviapplication/qwaylandcompositoriviapplicationplugin.cpp +++ b/src/imports/compositor-extensions/iviapplication/qwaylandcompositoriviapplicationplugin.cpp @@ -38,6 +38,25 @@ QT_BEGIN_NAMESPACE Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandIviApplication) +/*! + \qmlmodule QtWayland.Compositor.IviApplication + \title Qt Wayland IviApplication Extension + \ingroup qmlmodules + \brief Provides a Qt API for the IviApplication shell extension. + + \section2 Summary + IviApplication is a shell extension suitable for lightweight compositors, + for example in In-Vehicle Infotainment (IVI) systems. + + IviApplication corresponds to the Wayland \c ivi_application interface. + + \section2 Usage + To use this module, import it like this: + \qml + import QtWayland.Compositor.IviApplication + \endqml +*/ + class QWaylandCompositorIviApplicationPlugin : public QQmlExtensionPlugin { Q_OBJECT diff --git a/src/imports/compositor-extensions/presentationtime/qwaylandcompositorpresentationtimeplugin.cpp b/src/imports/compositor-extensions/presentationtime/qwaylandcompositorpresentationtimeplugin.cpp index 05ae4a46..3c524e7f 100644 --- a/src/imports/compositor-extensions/presentationtime/qwaylandcompositorpresentationtimeplugin.cpp +++ b/src/imports/compositor-extensions/presentationtime/qwaylandcompositorpresentationtimeplugin.cpp @@ -37,6 +37,28 @@ QT_BEGIN_NAMESPACE Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandPresentationTime) +/*! + \qmlmodule QtWayland.Compositor.PresentationTime + \title Qt Wayland Presentation Time Extension + \ingroup qmlmodules + \since 6.3 + \brief Provides tracking the timing when a frame is presented on screen. + + \section2 Summary + The PresentationTime extension provides a way to track rendering timing + for a surface. Client can request feedbacks associated with a surface, + then compositor send events for the feedback with the time when the surface + is presented on-screen. + + PresentationTime corresponds to the Wayland \c wp_presentation interface. + + \section2 Usage + To use this module, import it like this: + \qml + import QtWayland.Compositor.PresentationTime + \endqml +*/ + class QWaylandCompositorPresentationTimePlugin : public QQmlExtensionPlugin { Q_OBJECT diff --git a/src/imports/compositor-extensions/qtshell/qwaylandqtshellplugin.cpp b/src/imports/compositor-extensions/qtshell/qwaylandqtshellplugin.cpp index aead45cc..7600f27a 100644 --- a/src/imports/compositor-extensions/qtshell/qwaylandqtshellplugin.cpp +++ b/src/imports/compositor-extensions/qtshell/qwaylandqtshellplugin.cpp @@ -38,6 +38,29 @@ QT_BEGIN_NAMESPACE Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandQtShell) +/*! + \qmlmodule QtWayland.Compositor.QtShell + \title Qt Wayland Qt Shell Extension + \ingroup qmlmodules + \since 6.3 + \brief Provides a shell extension for Qt applications running on a Qt Wayland Compositor. + + \section2 Summary + The QtShell extension provides a way to associate an QtShellSurface with a regular Wayland + surface. The QtShell extension is written to support the window management features which are + supported by Qt. It may be suitable on a platform where both the compositor and client + applications are written with Qt, and where applications are trusted not to abuse features such + as manual window positioning and "bring-to-front". + + For other use cases, consider using IviApplication or XdgShell instead. + + \section2 Usage + To use this module, import it like this: + \qml + import QtWayland.Compositor.IviApplication + \endqml +*/ + class QQtWaylandShellPlugin : public QQmlExtensionPlugin { Q_OBJECT diff --git a/src/imports/compositor-extensions/wlshell/qwaylandcompositorwlshellplugin.cpp b/src/imports/compositor-extensions/wlshell/qwaylandcompositorwlshellplugin.cpp index 9193425e..fbada63d 100644 --- a/src/imports/compositor-extensions/wlshell/qwaylandcompositorwlshellplugin.cpp +++ b/src/imports/compositor-extensions/wlshell/qwaylandcompositorwlshellplugin.cpp @@ -37,6 +37,26 @@ QT_BEGIN_NAMESPACE Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandWlShell) +/*! + \qmlmodule QtWayland.Compositor.WlShell + \title Qt Wayland WlShell extension + \ingroup qmlmodules + \brief Provides a Qt API for the WlShell extension. + + \section2 Summary + WlShell is a shell extension providing window system features typical to + desktop systems. It is superseded by XdgShell and exists in Qt mainly + for backwards compatibility with older applications. + + WlShell corresponds to the Wayland interface \c wl_shell. + + \section2 Usage + To use this module, import it like this: + \qml + import QtWayland.Compositor.WlShell + \endqml +*/ + class QWaylandCompositorWlShellPlugin : public QQmlExtensionPlugin { Q_OBJECT diff --git a/src/imports/compositor-extensions/xdgshell/qwaylandcompositorxdgshellplugin.cpp b/src/imports/compositor-extensions/xdgshell/qwaylandcompositorxdgshellplugin.cpp index 9ea8a115..1693137c 100644 --- a/src/imports/compositor-extensions/xdgshell/qwaylandcompositorxdgshellplugin.cpp +++ b/src/imports/compositor-extensions/xdgshell/qwaylandcompositorxdgshellplugin.cpp @@ -41,6 +41,25 @@ Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandXdgShell) Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandXdgDecorationManagerV1) Q_COMPOSITOR_DECLARE_QUICK_EXTENSION_CLASS(QWaylandXdgOutputManagerV1) +/*! + \qmlmodule QtWayland.Compositor.XdgShell + \title Qt Wayland XdgShell Extension + \ingroup qmlmodules + \brief Provides a Qt API for the XdgShell shell extension. + + \section2 Summary + XdgShell is a shell extension providing window system features typical to + desktop systems. + + XdgShell corresponds to the Wayland interface, \c xdg_shell. + + \section2 Usage + To use this module, import it like this: + \qml + import QtWayland.Compositor.XdgShell + \endqml +*/ + class QWaylandCompositorXdgShellPlugin : public QQmlExtensionPlugin { Q_OBJECT -- cgit v1.2.1