From 6a15704c9f4be973947f18ff90afd725b7135ca9 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 11 Apr 2023 11:54:22 +0000 Subject: Doc: Use the \examplecategory macro to tag examples The '\meta category' command was used for tagging examples with a specific category, used in Qt Creators Welcome mode. As we want to also generate lists of examples belonging to a category elsewhere in the documentation, replace the command with a macro that expands to the original \meta command and also adds the example to a group using the \ingroup command. This way, the category names can be used as arguments to the \generatelist or \annotatedlist commands. Task-number: QTBUG-112731 Change-Id: I86a8a71204d1dd0665ca6d8c40438c78817c007a Reviewed-by: Paul Wicking (cherry picked from commit 9130a67c5981abc35be406da593f3a4b7f8e281f) --- examples/wayland/custom-shell/doc/src/custom-shell.qdoc | 2 +- examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc | 2 +- examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc | 2 +- examples/wayland/multi-output/doc/src/multi-output.qdoc | 2 +- examples/wayland/multi-screen/doc/src/multi-screen.qdoc | 2 +- examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc | 2 +- examples/wayland/pure-qml/doc/src/pure-qml.qdoc | 2 +- examples/wayland/qtshell/doc/src/qtshell.qdoc | 2 +- .../wayland/server-side-decoration/doc/src/server-side-decoration.qdoc | 2 +- examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/examples/wayland/custom-shell/doc/src/custom-shell.qdoc b/examples/wayland/custom-shell/doc/src/custom-shell.qdoc index 01cb48f7..b4938c03 100644 --- a/examples/wayland/custom-shell/doc/src/custom-shell.qdoc +++ b/examples/wayland/custom-shell/doc/src/custom-shell.qdoc @@ -4,7 +4,7 @@ /*! * \title Custom Shell * \example custom-shell - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief Custom Shell shows how to implement a custom shell extension. * \ingroup qtwaylandcompositor-examples * diff --git a/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc b/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc index f220476e..9412cca7 100644 --- a/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc +++ b/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc @@ -4,7 +4,7 @@ /*! * \title IVI Compositor * \example ivi-compositor - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief IVI Compositor is an example that demonstrates how to use the IviApplication extension. * \ingroup qtwaylandcompositor-examples * diff --git a/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc b/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc index 2be82ac4..9670219b 100644 --- a/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc +++ b/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc @@ -4,7 +4,7 @@ /*! * \title Minimal QML * \example minimal-qml - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief Minimal QML is a simple example that demonstrates how to write a Wayland compositor in QML. * \ingroup qtwaylandcompositor-examples * diff --git a/examples/wayland/multi-output/doc/src/multi-output.qdoc b/examples/wayland/multi-output/doc/src/multi-output.qdoc index 6f0ea7b7..5614099e 100644 --- a/examples/wayland/multi-output/doc/src/multi-output.qdoc +++ b/examples/wayland/multi-output/doc/src/multi-output.qdoc @@ -4,7 +4,7 @@ /*! \title Multi Output \example multi-output - \meta category {Embedded} + \examplecategory {Embedded} \brief Multi Output is an example that demonstrates a compositor with multiple outputs. \ingroup qtwaylandcompositor-examples diff --git a/examples/wayland/multi-screen/doc/src/multi-screen.qdoc b/examples/wayland/multi-screen/doc/src/multi-screen.qdoc index c2389237..b8113e02 100644 --- a/examples/wayland/multi-screen/doc/src/multi-screen.qdoc +++ b/examples/wayland/multi-screen/doc/src/multi-screen.qdoc @@ -4,7 +4,7 @@ /*! * \title Multi Screen * \example multi-screen - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief Multi Screen is a desktop-style Wayland compositor for multiple screens. * \ingroup qtwaylandcompositor-examples * diff --git a/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc b/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc index e0b13937..8ac3dfae 100644 --- a/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc +++ b/examples/wayland/overview-compositor/doc/src/overview-compositor.qdoc @@ -4,7 +4,7 @@ /*! * \title Overview Compositor * \example overview-compositor - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief Overview Compositor shows how to switch between clients in a grid. * * \section1 Introduction diff --git a/examples/wayland/pure-qml/doc/src/pure-qml.qdoc b/examples/wayland/pure-qml/doc/src/pure-qml.qdoc index 0fcb231d..d73c82e9 100644 --- a/examples/wayland/pure-qml/doc/src/pure-qml.qdoc +++ b/examples/wayland/pure-qml/doc/src/pure-qml.qdoc @@ -4,7 +4,7 @@ /*! \title Pure QML \example pure-qml - \meta category {Embedded} + \examplecategory {Embedded} \brief Pure QML is an example that demonstrates how to write a Wayland compositor in pure QML. \ingroup qtwaylandcompositor-examples diff --git a/examples/wayland/qtshell/doc/src/qtshell.qdoc b/examples/wayland/qtshell/doc/src/qtshell.qdoc index 9cd3d760..8f8a77b9 100644 --- a/examples/wayland/qtshell/doc/src/qtshell.qdoc +++ b/examples/wayland/qtshell/doc/src/qtshell.qdoc @@ -4,7 +4,7 @@ /*! * \title QtShell Compositor * \example qtshell - * \meta category {Embedded} + * \examplecategory {Embedded} * \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 a48e4c47..ebbd1b14 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 @@ -4,7 +4,7 @@ /*! * \title Server Side Decoration Compositor * \example server-side-decoration - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief Server Side Decoration Compositor is a simple example that demonstrates server side window decorations on xdg-shell. * \ingroup qtwaylandcompositor-examples * diff --git a/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc b/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc index 82568ec0..7c548171 100644 --- a/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc +++ b/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc @@ -4,7 +4,7 @@ /*! * \title Spanning Screens * \example spanning-screens - * \meta category {Embedded} + * \examplecategory {Embedded} * \brief Spanning Screens is an example that demonstrates how to let Wayland clients span multiple screens. * \ingroup qtwaylandcompositor-examples * -- cgit v1.2.1