diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-11 11:55:26 +0000 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-04-11 15:45:59 +0000 |
| commit | 54b3e7371ddd18c1da8db078422a46abc44447ce (patch) | |
| tree | 39a7a8afbfef3188115a22758e385d6f5848a832 | |
| parent | 54e12f9a457573263111cf29ca295db0e04e441e (diff) | |
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: Id3602b068a553dcf16c9dfd642ce4ab2fecdcb94
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit 7677d02223f1459b80ce714ecce1148a3e717918)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
3 files changed, 3 insertions, 3 deletions
diff --git a/examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc b/examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc index 94274282..76f3f92a 100644 --- a/examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc +++ b/examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc @@ -5,7 +5,7 @@ \example logfilepositionsource \title Log File Position Source (C++) \ingroup qtpositioning-examples -\meta category {Positioning & Location} +\examplecategory {Positioning & Location} \brief Logfile Position Source shows how to create and work with a custom position source. It can be useful for simulating GPS data, or when the diff --git a/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc b/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc index a135e339..9a0c0d1f 100644 --- a/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc +++ b/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc @@ -4,7 +4,7 @@ /*! \example satelliteinfo \title SatelliteInfo (QML) - \meta category {Positioning & Location} + \examplecategory {Positioning & Location} \brief The SatelliteInfo example shows the available satellites using Sky View or RSSI View and the user's current position. The satellites diff --git a/examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc b/examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc index d332329f..857d695e 100644 --- a/examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc +++ b/examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc @@ -4,7 +4,7 @@ /*! \example weatherinfo \title Weather Info (C++/QML) - \meta category {Positioning & Location} + \examplecategory {Positioning & Location} \brief The Weather Info example shows how to use the user's current position to retrieve local content from a web service in a C++ plugin for QML. |