diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-11 11:57:41 +0000 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-04-12 13:07:53 +0000 |
| commit | 52aa179311877a7a87f897a42e561e1fa93fa74e (patch) | |
| tree | 5b1d84bfe8c4df629cd9b7ef6055456ef9c70e18 | |
| parent | 7f5e532543ee0f5e827a697bc2962f6b5787686a (diff) | |
| download | qtdoc-52aa179311877a7a87f897a42e561e1fa93fa74e.tar.gz | |
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: I8590894bdd31d69c38a60cdd42f7301e2cecd2ed
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit b597ecb9543c1bd8253baa2c5819b943f9b8ed56)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
4 files changed, 4 insertions, 4 deletions
diff --git a/examples/demos/calqlatr/doc/src/calqlatr.qdoc b/examples/demos/calqlatr/doc/src/calqlatr.qdoc index 348f3242..a26671cd 100644 --- a/examples/demos/calqlatr/doc/src/calqlatr.qdoc +++ b/examples/demos/calqlatr/doc/src/calqlatr.qdoc @@ -8,7 +8,7 @@ \brief A Qt Quick app designed for portrait devices that uses custom components, animated with AnimationController, and JavaScript for the application logic. \meta {tag} {quick} - \meta {category} {Application Examples} + \examplecategory {Application Examples} \image qtquick-demo-calqlatr.png \e{Calqlatr} demonstrates various QML and \l{Qt Quick} features, such as diff --git a/examples/demos/coffee/coffee.qdoc b/examples/demos/coffee/coffee.qdoc index 22cf991a..38e67284 100644 --- a/examples/demos/coffee/coffee.qdoc +++ b/examples/demos/coffee/coffee.qdoc @@ -8,7 +8,7 @@ \ingroup qtquickdemos \brief A Qt Quick application with a state-based custom user interface. \meta {tag} {quick,embedded,states,touch} - \meta {category} {Application Examples} + \examplecategory {Application Examples} \borderedimage coffee_machine_overview.png diff --git a/examples/demos/colorpaletteclient/doc/src/colorpaletteclient.qdoc b/examples/demos/colorpaletteclient/doc/src/colorpaletteclient.qdoc index 095e9309..53e062cb 100644 --- a/examples/demos/colorpaletteclient/doc/src/colorpaletteclient.qdoc +++ b/examples/demos/colorpaletteclient/doc/src/colorpaletteclient.qdoc @@ -4,7 +4,7 @@ /*! \ingroup qtquickdemos \example demos/colorpaletteclient -\meta category {Networking} +\examplecategory {Networking} \meta tags {quick, network, http} \title Qt Quick Demo - RESTful Color Palette API client \brief Example of how to create a RESTful API QML client. diff --git a/examples/demos/photosurface/doc/src/photosurface.qdoc b/examples/demos/photosurface/doc/src/photosurface.qdoc index da089734..81dfe449 100644 --- a/examples/demos/photosurface/doc/src/photosurface.qdoc +++ b/examples/demos/photosurface/doc/src/photosurface.qdoc @@ -10,7 +10,7 @@ to handle pinch gestures on the fetched content. \image qtquick-demo-photosurface-small.png \meta {tag} {quick,touch} - \meta {category} {Application Examples} + \examplecategory {Application Examples} \e{Photo Surface} demonstrates how to use a \l{Repeater} with a \l FolderListModel and a \l FolderDialog to access images from a folder selected |