diff options
author | Kai Uwe Broulik <kde@privat.broulik.de> | 2021-04-19 15:12:01 +0200 |
---|---|---|
committer | Kai Uwe Broulik <kde@privat.broulik.de> | 2021-04-26 14:57:37 +0200 |
commit | a04decb6a85ef254ec48842e7551a2920de6a714 (patch) | |
tree | c82365fc507e58c1333b711dce395fe937e0dd4c /src/compositor | |
parent | 047efea15ea18243a5912615173f88aeb1dac306 (diff) |
Docs: Add "instantiates" keywords
Document what the corresponding C++ class for any given QML item is,
like it's done in Qt Declarative.
Pick-to: 5.15
Change-Id: I015565f88cb457f1e73dd7c2c54edff3505db395
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
Diffstat (limited to 'src/compositor')
17 files changed, 21 insertions, 0 deletions
diff --git a/src/compositor/compositor_api/qwaylandclient.cpp b/src/compositor/compositor_api/qwaylandclient.cpp index 950424adb..9ca61d608 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 59809f774..61da00016 100644 --- a/src/compositor/compositor_api/qwaylandcompositor.cpp +++ b/src/compositor/compositor_api/qwaylandcompositor.cpp @@ -490,6 +490,7 @@ QWaylandSeat *QWaylandCompositorPrivate::seatFor(QInputEvent *inputEvent) /*! \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 d850f3eba..3fb8a601c 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 631b2ed18..fc18574d0 100644 --- a/src/compositor/compositor_api/qwaylandquickitem.cpp +++ b/src/compositor/compositor_api/qwaylandquickitem.cpp @@ -423,6 +423,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 591674ce8..ad664ccf9 100644 --- a/src/compositor/compositor_api/qwaylandseat.cpp +++ b/src/compositor/compositor_api/qwaylandseat.cpp @@ -137,6 +137,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 efd186fc5..fc10be111 100644 --- a/src/compositor/compositor_api/qwaylandsurface.cpp +++ b/src/compositor/compositor_api/qwaylandsurface.cpp @@ -363,6 +363,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 844da7c5d..1a55d5894 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 d4937c6c9..c14d409b8 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 d0eb4d0b2..e3b7ed6f1 100644 --- a/src/compositor/extensions/qwaylandiviapplication.cpp +++ b/src/compositor/extensions/qwaylandiviapplication.cpp @@ -39,6 +39,7 @@ QT_BEGIN_NAMESPACE /*! * \qmltype IviApplication + * \instantiates QWaylandIviApplication * \inqmlmodule QtWayland.Compositor.IviApplication * \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 382edb2ca..8cc63a8d0 100644 --- a/src/compositor/extensions/qwaylandivisurface.cpp +++ b/src/compositor/extensions/qwaylandivisurface.cpp @@ -45,6 +45,7 @@ QWaylandSurfaceRole QWaylandIviSurfacePrivate::s_role("ivi_surface"); /*! * \qmltype IviSurface + * \instantiates QWaylandIviSurface * \inqmlmodule QtWayland.Compositor.IviApplication * \since 5.8 * \brief Provides a simple way to identify and resize a surface. diff --git a/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp b/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp index 271c3ec52..9406482e4 100644 --- a/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp +++ b/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp @@ -56,6 +56,7 @@ void QWaylandQtTextInputMethodManagerPrivate::text_input_method_manager_v1_get_t /*! \qmltype QtTextInputMethodManager + \instantiates QWaylandQtTextInputMethodManager \inqmlmodule QtWayland.Compositor \since 6.0 \brief Provides access to input methods in the compositor. diff --git a/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp b/src/compositor/extensions/qwaylandquickshellsurfaceitem.cpp index f11a5e3c8..8928d803d 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 d79be9bb2..d7f0c4018 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 7b3c7628d..fab480651 100644 --- a/src/compositor/extensions/qwaylandwlshell.cpp +++ b/src/compositor/extensions/qwaylandwlshell.cpp @@ -244,6 +244,7 @@ void QWaylandWlShellSurfacePrivate::shell_surface_set_class(Resource *resource, /*! * \qmltype WlShell + * \instantiates QWaylandWlShell * \inqmlmodule QtWayland.Compositor.WlShell * \since 5.8 * \brief Provides an extension for desktop-style user interfaces. @@ -413,6 +414,7 @@ QByteArray QWaylandWlShell::interfaceName() /*! * \qmltype WlShellSurface + * \instantiates QWaylandWlShellSurface * \inqmlmodule QtWayland.Compositor.WlShell * \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 12cecccf0..a6ef44310 100644 --- a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp +++ b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp @@ -39,6 +39,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype XdgDecorationManagerV1 + \instantiates QWaylandXdgDecorationManagerV1 \inqmlmodule QtWayland.Compositor.XdgShell \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 ead14ae78..5d623a1cd 100644 --- a/src/compositor/extensions/qwaylandxdgoutputv1.cpp +++ b/src/compositor/extensions/qwaylandxdgoutputv1.cpp @@ -38,6 +38,7 @@ QT_BEGIN_NAMESPACE /*! * \qmltype XdgOutputManagerV1 + * \instantiates QWaylandXdgOutputManagerV1 * \inqmlmodule QtWayland.Compositor.XdgShell * \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 8483f0a6b..0ca9149d7 100644 --- a/src/compositor/extensions/qwaylandxdgshell.cpp +++ b/src/compositor/extensions/qwaylandxdgshell.cpp @@ -134,6 +134,7 @@ void QWaylandXdgShellPrivate::xdg_wm_base_pong(Resource *resource, uint32_t seri /*! * \qmltype XdgShell + * \instantiates QWaylandXdgShell * \inqmlmodule QtWayland.Compositor.XdgShell * \since 5.12 * \brief Provides an extension for desktop-style user interfaces. @@ -454,6 +455,7 @@ void QWaylandXdgSurfacePrivate::xdg_surface_set_window_geometry(QtWaylandServer: /*! * \qmltype XdgSurface + * \instantiates QWaylandXdgSurface * \inqmlmodule QtWayland.Compositor.XdgShell * \since 5.12 * \brief XdgSurface provides desktop-style compositor-specific features to an xdg surface. @@ -703,6 +705,7 @@ QWaylandQuickShellIntegration *QWaylandXdgSurface::createIntegration(QWaylandQui /*! * \qmltype XdgToplevel + * \instantiates QWaylandXdgToplevel * \inqmlmodule QtWayland.Compositor.XdgShell * \since 5.12 * \brief XdgToplevel represents the toplevel window specific parts of an xdg surface. @@ -1540,6 +1543,7 @@ void QWaylandXdgToplevelPrivate::xdg_toplevel_set_minimized(QtWaylandServer::xdg /*! * \qmltype XdgPopup + * \instantiates QWaylandXdgPopup * \inqmlmodule QtWayland.Compositor.XdgShell * \since 5.12 * \brief XdgPopup represents the popup specific parts of and xdg surface. |