From 7279455beec070d83d6d685ca904b0eca4b4e857 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 11 Apr 2023 11:53: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: I1df2d3bd6f2ef904ac7bac4d606b93d3824a802a Reviewed-by: Paul Wicking (cherry picked from commit 6d00c732c46b295402c5cbc05c3b73cb4cd833b5) Reviewed-by: Qt Cherry-pick Bot --- examples/bluetooth/btchat/doc/src/btchat.qdoc | 2 +- examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc | 2 +- examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc | 2 +- examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc | 2 +- examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/bluetooth/btchat/doc/src/btchat.qdoc b/examples/bluetooth/btchat/doc/src/btchat.qdoc index aa0b189b..5ad11502 100644 --- a/examples/bluetooth/btchat/doc/src/btchat.qdoc +++ b/examples/bluetooth/btchat/doc/src/btchat.qdoc @@ -4,7 +4,7 @@ /*! \example btchat \title Bluetooth Chat - \meta category {Connectivity} + \examplecategory {Connectivity} \brief Shows communication through Bluetooth using RFCOMM protocol. The Bluetooth Chat example shows how to use the \l{Qt Bluetooth} API to communicate diff --git a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc index 256ff243..2c8cadba 100644 --- a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc +++ b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc @@ -4,7 +4,7 @@ /*! \example heartrate-game \title Bluetooth Low Energy Heart Rate Game - \meta category {Connectivity} + \examplecategory {Connectivity} \brief A game demonstrating the interaction with a Bluetooth Low Energy Heart Rate device/service. diff --git a/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc b/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc index c4b5550b..389a43ad 100644 --- a/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc +++ b/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc @@ -4,7 +4,7 @@ /*! \example heartrate-server \title Bluetooth Low Energy Heart Rate Server - \meta category {Connectivity} + \examplecategory {Connectivity} \brief An example demonstrating how to set up and advertise a GATT service. The example demonstrates the use of the Qt Bluetooth Low Energy classes related to peripheral (slave) functionality. diff --git a/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc b/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc index 583687fd..3e11a9e8 100644 --- a/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc +++ b/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc @@ -5,7 +5,7 @@ /*! \example lowenergyscanner \title Bluetooth Low Energy Scanner - \meta category {Connectivity} + \examplecategory {Connectivity} \brief An application designed to browse the content of Bluetooth Low Energy peripheral devices. The example demonstrates the use of all Qt Bluetooth Low Energy classes. diff --git a/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc b/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc index 9bdb3090..1041c70f 100644 --- a/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc +++ b/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc @@ -4,7 +4,7 @@ /*! \example annotatedurl \title Annotated URL -\meta category {Connectivity} +\examplecategory {Connectivity} \brief The example shows reading from formatted NFC Data Exchange Format (NDEF) messages. The Annotated URL example displays the contents of specifically -- cgit v1.2.1