diff options
author | Topi Reinio <topi.reinio@qt.io> | 2023-04-11 11:53:22 +0000 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2023-04-11 13:34:19 +0000 |
commit | 6d00c732c46b295402c5cbc05c3b73cb4cd833b5 (patch) | |
tree | e417379aff4417cff93571d8b3a0fb0c647648ff | |
parent | 8df4e6992501877f3286e58992142b137789c799 (diff) | |
download | qtconnectivity-6d00c732c46b295402c5cbc05c3b73cb4cd833b5.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.
Pick-to: 6.5
Task-number: QTBUG-112731
Change-Id: I1df2d3bd6f2ef904ac7bac4d606b93d3824a802a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
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 c45f4643..7bfdb8f6 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 c5ccf1de..e3e625aa 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 4a9bff9e..df7f8484 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 |