summaryrefslogtreecommitdiff
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
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>
-rw-r--r--examples/wayland/custom-shell/doc/src/custom-shell.qdoc6
-rw-r--r--examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc4
-rw-r--r--examples/wayland/minimal-cpp/doc/src/minimal-cpp.qdoc6
-rw-r--r--examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc6
-rw-r--r--examples/wayland/multi-output/doc/src/multi-output.qdoc7
-rw-r--r--examples/wayland/multi-screen/doc/src/multi-screen.qdoc6
-rw-r--r--examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc7
-rw-r--r--examples/wayland/pure-qml/doc/src/pure-qml.qdoc10
-rw-r--r--examples/wayland/qtshell/doc/src/qtshell.qdoc2
-rw-r--r--examples/wayland/server-side-decoration/doc/src/server-side-decoration.qdoc4
-rw-r--r--examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc11
-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
19 files changed, 44 insertions, 51 deletions
diff --git a/examples/wayland/custom-shell/doc/src/custom-shell.qdoc b/examples/wayland/custom-shell/doc/src/custom-shell.qdoc
index 75f88fd2..b1a09994 100644
--- a/examples/wayland/custom-shell/doc/src/custom-shell.qdoc
+++ b/examples/wayland/custom-shell/doc/src/custom-shell.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - Custom Shell
+ * \title Custom Shell
* \example custom-shell
* \brief Custom Shell shows how to implement a custom shell extension.
* \ingroup qtwaylandcompositor-examples
@@ -122,11 +122,11 @@
*
* The final part of the example is the compositor itself. This has the same general structure as
* the other compositor examples. See the
- * \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example} for more details on
+ * \l{Minimal QML}{Minimal QML example} for more details on
* the building blocks of a \l{Qt Wayland Compositor}.
*
* One notable difference in the Custom Shell compositor is the instantiation of the shell
- * extension. Where the \l{Qt Wayland Compositor Examples - Minimal QML}{the Minimal QML example}
+ * extension. Where the \l{Minimal QML}{the Minimal QML example}
* instantiates the shell extensions \l{IviApplication}, \l{XdgShell} and \l{WlShell}, the
* Custom Shell example only creates an instance of the \c ExampleShell extension.
*
diff --git a/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc b/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc
index bf4d0500..98c4e179 100644
--- a/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc
+++ b/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - IVI Compositor
+ * \title IVI Compositor
* \example ivi-compositor
* \brief IVI Compositor is an example that demonstrates how to use the IviApplication extension.
* \ingroup qtwaylandcompositor-examples
@@ -13,7 +13,7 @@
* server (also known as a Wayland compositor).
*
* For an introduction to the basic principles of creating a \l{Qt Wayland Compositor} with Qt,
- * see the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}.
+ * see the \l{Minimal QML}{Minimal QML example}.
*
* \section1 The Protocol
*
diff --git a/examples/wayland/minimal-cpp/doc/src/minimal-cpp.qdoc b/examples/wayland/minimal-cpp/doc/src/minimal-cpp.qdoc
index a9092170..7690d1ce 100644
--- a/examples/wayland/minimal-cpp/doc/src/minimal-cpp.qdoc
+++ b/examples/wayland/minimal-cpp/doc/src/minimal-cpp.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \title Qt Wayland Compositor Examples - Minimal CPP
+ \title Minimal CPP
\example minimal-cpp
\brief Minimal CPP is an example that demonstrates how to write a Wayland compositor in C++.
\ingroup qtwaylandcompositor-examples
@@ -11,8 +11,8 @@
using C++. The C++ API of QtWaylandCompositor is low-level and intended for specialized
applications, such as supporting hardware features, or if Qt Quick is not available. The QML API
offers more convenience and functionality. For comparison, the
- \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example} implements more
- functionality with 30 lines of QML than this example does in 300+ lines.
+ \l{Minimal QML}{Minimal QML example} implements more functionality with 30 lines of QML than this
+ example does in 300+ lines.
\image minimal-cpp.jpg
diff --git a/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc b/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc
index 66b4773f..b6bf9aa5 100644
--- a/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc
+++ b/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - Minimal QML
+ * \title Minimal QML
* \example minimal-qml
* \brief Minimal QML is a simple example that demonstrates how to write a Wayland compositor in QML.
* \ingroup qtwaylandcompositor-examples
@@ -64,7 +64,7 @@
* a \l WaylandOutput object as the direct child of the \l WaylandCompositor. If there is only
* a single output, this will represent the primary screen on the system. (You may also create
* multiple \l WaylandOutput objects to address multiple screens if they are available. See
- * the \l{Qt Wayland Compositor Examples - Multi Screen}{Multi Screen example} for more details
+ * the \l{Multi Screen}{Multi Screen example} for more details
* about this.)
*
* \snippet minimal-qml/main.qml output
@@ -88,5 +88,5 @@
*
* And this is all the code needed to create a functional Wayland compositor using Qt Quick and
* QML. For another example of a compositor written in QML but which has a few more features, take
- * a look at the \l{Qt Wayland Compositor Examples - Pure QML}{Pure QML example}.
+ * a look at the \l{Pure QML}{Pure QML example}.
*/
diff --git a/examples/wayland/multi-output/doc/src/multi-output.qdoc b/examples/wayland/multi-output/doc/src/multi-output.qdoc
index ee5a3c29..da77eb0f 100644
--- a/examples/wayland/multi-output/doc/src/multi-output.qdoc
+++ b/examples/wayland/multi-output/doc/src/multi-output.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \title Qt Wayland Compositor Examples - Multi Output
+ \title Multi Output
\example multi-output
\brief Multi Output is an example that demonstrates a compositor with multiple outputs.
\ingroup qtwaylandcompositor-examples
@@ -17,7 +17,7 @@
\image multi-output.jpg
For an introduction to the basic principles of creating a \l{Qt Wayland Compositor} with Qt,
- see the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}.
+ see the \l{Minimal QML}{Minimal QML example}.
\section1 Multiple Outputs
@@ -49,6 +49,5 @@
\l Qt::AA_ShareOpenGLContexts attribute must be set before the \l QGuiApplication
object is constructed.
- \sa {Qt Wayland Compositor Examples - Multi Screen},
- {Qt Wayland Compositor Examples - Overview Compositor}
+ \sa {Multi Screen}, {Overview Compositor}
*/
diff --git a/examples/wayland/multi-screen/doc/src/multi-screen.qdoc b/examples/wayland/multi-screen/doc/src/multi-screen.qdoc
index 07374b78..6acd9269 100644
--- a/examples/wayland/multi-screen/doc/src/multi-screen.qdoc
+++ b/examples/wayland/multi-screen/doc/src/multi-screen.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - Multi Screen
+ * \title Multi Screen
* \example multi-screen
* \brief Multi Screen is a desktop-style Wayland compositor for multiple screens.
* \ingroup qtwaylandcompositor-examples
@@ -13,7 +13,7 @@
* screens.
*
* For an introduction to the basic principles of creating a \l{Qt Wayland Compositor} with Qt,
- * see the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}.
+ * see the \l{Minimal QML}{Minimal QML example}.
*
* \section1 Supporting multiple screens
*
@@ -61,5 +61,5 @@
*
* \snippet multi-screen/main.cpp share context
*
- * \sa {Qt Wayland Compositor Examples - Multi Output}
+ * \sa {Multi Output}
*/
diff --git a/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc b/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc
index d8408570..4b3bd4c5 100644
--- a/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc
+++ b/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - Overview Compositor
+ * \title Overview Compositor
* \example overview-compositor
* \brief Overview Compositor shows how to switch between clients in a grid.
*
@@ -14,7 +14,7 @@
* \image overview-compositor.jpg
*
* For an introduction to the basic principles of creating a \l{Qt Wayland Compositor} with Qt,
- * see the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}.
+ * see the \l{Minimal QML}{Minimal QML example}.
*
* \section1 Application Grid
*
@@ -58,8 +58,7 @@
*
* This example shows one way to have the compositor visualize clients in different modes. Another
* way to achieve similar effects is to create multiple Qt Quick items that refer to the same
- * surface. See \l{Qt Wayland Compositor Examples - Multi Output}{the Multi Output example} for a
- * demonstration.
+ * surface. See \l{Multi Output}{the Multi Output example} for a demonstration.
*
* \ingroup qtwaylandcompositor-examples
*/
diff --git a/examples/wayland/pure-qml/doc/src/pure-qml.qdoc b/examples/wayland/pure-qml/doc/src/pure-qml.qdoc
index b083c5d6..a7dfb11d 100644
--- a/examples/wayland/pure-qml/doc/src/pure-qml.qdoc
+++ b/examples/wayland/pure-qml/doc/src/pure-qml.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \title Qt Wayland Compositor Examples - Pure QML
+ \title Pure QML
\example pure-qml
\brief Pure QML is an example that demonstrates how to write a Wayland compositor in pure QML.
\ingroup qtwaylandcompositor-examples
@@ -12,15 +12,13 @@
Pure QML is a small desktop-style Wayland compositor example that demonstrates the power and
ease of the \l{Qt Wayland Compositor} QML APIs.
- The Pure QML example is similar to the
- \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}, in that it is a
+ The Pure QML example is similar to the \l{Minimal QML}{Minimal QML example}, in that it is a
full-blown Wayland compositor, implemented only using QML code.
\section1 Initializing the Compositor
- Like the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}, Pure QML
- supports the main \l{Shell Extensions - Qt Wayland Compositor}{shell extensions} that are
- supported by Qt.
+ Like the \l{Minimal QML}{Minimal QML example}, Pure QML supports the main
+ \l{Shell Extensions - Qt Wayland Compositor}{shell extensions} that are supported by Qt.
\snippet pure-qml/qml/main.qml shell extensions
diff --git a/examples/wayland/qtshell/doc/src/qtshell.qdoc b/examples/wayland/qtshell/doc/src/qtshell.qdoc
index 457bd92d..61e87e18 100644
--- a/examples/wayland/qtshell/doc/src/qtshell.qdoc
+++ b/examples/wayland/qtshell/doc/src/qtshell.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - QtShell Compositor
+ * \title QtShell Compositor
* \example qtshell
* \brief QtShell Compositor shows how to use the QtShell shell extension.
* \ingroup qtwaylandcompositor-examples
diff --git a/examples/wayland/server-side-decoration/doc/src/server-side-decoration.qdoc b/examples/wayland/server-side-decoration/doc/src/server-side-decoration.qdoc
index 48a84609..616e35a0 100644
--- a/examples/wayland/server-side-decoration/doc/src/server-side-decoration.qdoc
+++ b/examples/wayland/server-side-decoration/doc/src/server-side-decoration.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - Server Side Decoration Compositor
+ * \title Server Side Decoration Compositor
* \example server-side-decoration
* \brief Server Side Decoration Compositor is a simple example that demonstrates server side window decorations on xdg-shell.
* \ingroup qtwaylandcompositor-examples
@@ -15,7 +15,7 @@
* server-side window decorations.
*
* For an introduction to the basic principles of creating a \l{Qt Wayland Compositor} with Qt,
- * see the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}.
+ * see the \l{Minimal QML}{Minimal QML example}.
*
* \section1 Decorations
*
diff --git a/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc b/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc
index dd783a7e..1a583722 100644
--- a/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc
+++ b/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- * \title Qt Wayland Compositor Examples - Spanning Screens
+ * \title Spanning Screens
* \example spanning-screens
* \brief Spanning Screens is an example that demonstrates how to let Wayland clients span multiple screens.
* \ingroup qtwaylandcompositor-examples
@@ -15,7 +15,7 @@
* \image spanning-screens.jpg
*
* For an introduction to the basic principles of creating a \l{Qt Wayland Compositor} with Qt,
- * see the \l{Qt Wayland Compositor Examples - Minimal QML}{Minimal QML example}.
+ * see the \l{Minimal QML}{Minimal QML example}.
*
* \section1 Supporting Multiple Screens
*
@@ -48,11 +48,10 @@
*
* Referencing the same client surface from multiple items is a tool which can be used for many
* things. For a demonstration of a desktop-style compositor where windows can be moved from screen
- * to screen, take a look at the
- * \l{Qt Wayland Compositor Examples - Multi Screen}{Multi Screen example}.
+ * to screen, take a look at the \l{Multi Screen}{Multi Screen example}.
*
- * The \l{Qt Wayland Compositor Examples - Multi Output}{Multi Output example} shows how client
- * surfaces can be displayed on multiple outputs with different sizes and other properties.
+ * The \l{Multi Output}{Multi Output example} shows how client surfaces can be displayed on multiple
+ * outputs with different sizes and other properties.
*
* \note In order to support multiple Wayland outputs in the same compositor, the
* \l Qt::AA_ShareOpenGLContexts attribute must be set before the \l QGuiApplication
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)