diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-04-11 11:03:50 +0000 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-04-11 15:24:46 +0000 |
| commit | a21357225a100e0b35f08fee46f3679e30c5646b (patch) | |
| tree | d228b324ee82aeaa39e2425e479921b9b18b224c | |
| parent | 18244c43480688e08300f676a97de8fdba2e4923 (diff) | |
| download | qtserialport-a21357225a100e0b35f08fee46f3679e30c5646b.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: I207110715b0d3bab25d21ef91f7b0c833c0acb27
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit cfeca8077184f175fb5278d682b89ef1ad83bbfd)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | examples/serialport/doc/blockingreceiver.qdoc | 2 | ||||
| -rw-r--r-- | examples/serialport/doc/blockingsender.qdoc | 2 | ||||
| -rw-r--r-- | examples/serialport/doc/terminal.qdoc | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/examples/serialport/doc/blockingreceiver.qdoc b/examples/serialport/doc/blockingreceiver.qdoc index ad8feee..71a2084 100644 --- a/examples/serialport/doc/blockingreceiver.qdoc +++ b/examples/serialport/doc/blockingreceiver.qdoc @@ -6,7 +6,7 @@ \example blockingreceiver \title Blocking Receiver \ingroup qtserialport-examples - \meta category Connectivity + \examplecategory Connectivity \brief Shows how to use the synchronous API of QSerialPort in a non-GUI thread. diff --git a/examples/serialport/doc/blockingsender.qdoc b/examples/serialport/doc/blockingsender.qdoc index bf2c367..db28b72 100644 --- a/examples/serialport/doc/blockingsender.qdoc +++ b/examples/serialport/doc/blockingsender.qdoc @@ -7,7 +7,7 @@ \example blockingsender \title Blocking Sender \ingroup qtserialport-examples - \meta category Connectivity + \examplecategory Connectivity \brief Shows how to use the synchronous API of QSerialPort in a worker thread. diff --git a/examples/serialport/doc/terminal.qdoc b/examples/serialport/doc/terminal.qdoc index 84f3a54..c90a3c0 100644 --- a/examples/serialport/doc/terminal.qdoc +++ b/examples/serialport/doc/terminal.qdoc @@ -6,7 +6,7 @@ \example terminal \title Serial Terminal \ingroup qtserialport-examples - \meta category Connectivity + \examplecategory Connectivity \brief Shows how to use various features of QSerialPort. |