summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>2023-02-08 12:33:05 +0100
committerEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>2023-02-28 10:27:21 +0100
commitbc612e4ecc06aeba5f829913054614f959eca1a6 (patch)
tree89f078182c59a012c203906394e0fae77e44ff62 /src
parent34e3f7ecde67263c380938d2f4f690f9b41afb87 (diff)
downloadqtwayland-bc612e4ecc06aeba5f829913054614f959eca1a6.tar.gz
doc: Remove category from examples docs
Remove redundant categorization from example title as according to example guidelines. The examples are already categorized under Qt Wayland Compositor Examples, so adding it to the title makes the list a bit cluttered. Pick-to: 6.5 Task-number: QTBUG-110993 Change-Id: I91ad127611c7b1e4d8c558377bc5f46e0ec28a41 Reviewed-by: Inho Lee <inho.lee@qt.io> Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/compositor/compositor_api/qwaylandresource.cpp2
-rw-r--r--src/compositor/doc/src/qtwaylandcompositor-overview.qdoc4
-rw-r--r--src/compositor/doc/src/qtwaylandcompositor-shellextensions.qdoc7
-rw-r--r--src/compositor/extensions/qwaylandshellsurface.cpp2
-rw-r--r--src/compositor/extensions/qwaylandxdgdecorationv1.cpp3
-rw-r--r--src/compositor/global/qwaylandcompositorextension.cpp4
-rw-r--r--src/compositor/global/qwaylandquickextension.qdoc2
-rw-r--r--src/imports/compositor-extensions/qtshell/qwaylandqtshellchrome.cpp2
8 files changed, 12 insertions, 14 deletions
diff --git a/src/compositor/compositor_api/qwaylandresource.cpp b/src/compositor/compositor_api/qwaylandresource.cpp
index 1060462b..fc744c4b 100644
--- a/src/compositor/compositor_api/qwaylandresource.cpp
+++ b/src/compositor/compositor_api/qwaylandresource.cpp
@@ -15,7 +15,7 @@ QT_BEGIN_NAMESPACE
* The QWaylandResource is a simple wrapper around the Wayland type \c wl_resource, and makes it
* possible to use wl_resource pointers in Qt Quick APIs.
*
- * \sa {Qt Wayland Compositor Examples - Custom Shell}
+ * \sa {Custom Shell}
*/
/*!
diff --git a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
index dde06dbd..5d6d712d 100644
--- a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
+++ b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
@@ -97,8 +97,8 @@
when starting the compositor. The \c XDG_RUNTIME_DIR can point to any accessible location which
is not already in use.
- For instance, if you want to run the \l{Qt Wayland Compositor Examples - Pure QML}{pure-qml}
- example with the \c wayland-egl backend, you could use the following command line:
+ For instance, if you want to run the \l{Pure QML}{pure-qml} example with the
+ \c wayland-egl backend, you could use the following command line:
\code
% XDG_RUNTIME_DIR=~/my_temporary_runtime QT_XCB_GL_INTEGRATION=xcb_egl QT_WAYLAND_CLIENT_BUFFER_INTEGRATION=wayland-egl ./pure-qml
diff --git a/src/compositor/doc/src/qtwaylandcompositor-shellextensions.qdoc b/src/compositor/doc/src/qtwaylandcompositor-shellextensions.qdoc
index ceff72a7..5494eeda 100644
--- a/src/compositor/doc/src/qtwaylandcompositor-shellextensions.qdoc
+++ b/src/compositor/doc/src/qtwaylandcompositor-shellextensions.qdoc
@@ -31,8 +31,7 @@
\li \l IviApplication is a minimalistic protocol, originally intended for In-vehicle
Infotainment systems. It is useful for embedded systems, where a pre-defined set of
applications can run, often with pre-assigned screen real estate. For some more details
- on this protocol, see the
- \l{Qt Wayland Compositor Examples - IVI Compositor}{IVI Compositor example}.
+ on this protocol, see the \l{IVI Compositor}{IVI Compositor example}.
\li \l QtShell is a specialized shell for Qt applications which supports the window management
features available in 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
@@ -47,6 +46,6 @@
applications involved which are not written in Qt and which have their own requirements.
A Qt Wayland Compositor can also support multiple shell extensions at once. See the
- \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example} for an example where
- all three shell extensions listed above are supported.
+ \l{Minimal QML}{Minimal QML example} for an example where all three shell extensions listed
+ above are supported.
*/
diff --git a/src/compositor/extensions/qwaylandshellsurface.cpp b/src/compositor/extensions/qwaylandshellsurface.cpp
index fe15739f..37b4199f 100644
--- a/src/compositor/extensions/qwaylandshellsurface.cpp
+++ b/src/compositor/extensions/qwaylandshellsurface.cpp
@@ -26,7 +26,7 @@
*
* The same usage pattern applies as for QWaylandCompositorExtensionTemplate.
*
- * \sa {Qt Wayland Compositor Examples - Custom Shell}
+ * \sa { Custom Shell}
*/
/*!
diff --git a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp
index 64141b5f..64a92a89 100644
--- a/src/compositor/extensions/qwaylandxdgdecorationv1.cpp
+++ b/src/compositor/extensions/qwaylandxdgdecorationv1.cpp
@@ -43,8 +43,7 @@ QT_BEGIN_NAMESPACE
}
\endqml
- \sa QWaylandXdgToplevel::decorationMode,
- {Qt Wayland Compositor Examples - Server Side Decoration Compositor}
+ \sa QWaylandXdgToplevel::decorationMode, {Server Side Decoration Compositor}
*/
/*!
diff --git a/src/compositor/global/qwaylandcompositorextension.cpp b/src/compositor/global/qwaylandcompositorextension.cpp
index 639215fc..d9c42b29 100644
--- a/src/compositor/global/qwaylandcompositorextension.cpp
+++ b/src/compositor/global/qwaylandcompositorextension.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
*
* In this example, \c MyExtension is an implementation of the generated interface \c my_extension.
*
- * \sa {Qt Wayland Compositor Examples - Custom Shell}
+ * \sa {Custom Shell}
*/
/*!
@@ -68,7 +68,7 @@ QT_BEGIN_NAMESPACE
* For example, for registering global extensions, you can inherit from QWaylandCompositorExtension
* and pass the QWaylandCompositor object as extension container.
*
- * \sa QWaylandCompositorExtensionTemplate, {Qt Wayland Compositor Examples - Custom Shell}
+ * \sa QWaylandCompositorExtensionTemplate, {Custom Shell}
*/
/*!
diff --git a/src/compositor/global/qwaylandquickextension.qdoc b/src/compositor/global/qwaylandquickextension.qdoc
index 539b2c30..5977e56c 100644
--- a/src/compositor/global/qwaylandquickextension.qdoc
+++ b/src/compositor/global/qwaylandquickextension.qdoc
@@ -13,7 +13,7 @@
* If you are creating extensions to Qt Wayland Compositor, the macros in the QWaylandQuickExtension
* header may be a useful alternative to manually implementing the required parts for each class.
*
- * \sa {Qt Wayland Compositor Examples - Custom Shell}
+ * \sa {Custom Shell}
*/
/*!
diff --git a/src/imports/compositor-extensions/qtshell/qwaylandqtshellchrome.cpp b/src/imports/compositor-extensions/qtshell/qwaylandqtshellchrome.cpp
index f1584200..47fe586a 100644
--- a/src/imports/compositor-extensions/qtshell/qwaylandqtshellchrome.cpp
+++ b/src/imports/compositor-extensions/qtshell/qwaylandqtshellchrome.cpp
@@ -112,7 +112,7 @@ void QWaylandQtShellChromePrivate::updateDecorationInteraction(quint8 flags,
*
* The QtShellChrome is intended to be used together with QtShell and QtShellSurface.
*
- * \sa {Qt Wayland Compositor Examples - QtShell Compositor}
+ * \sa {QtShell Compositor}
*/
QWaylandQtShellChrome::QWaylandQtShellChrome(QQuickItem *parent)
: QQuickItem(*new QWaylandQtShellChromePrivate{}, parent)