From 45ca5c85855c6107813485e7977ea9a791cba6b9 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 11 Apr 2023 12:02:10 +0000 Subject: [PATCH] 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: I46762dabc5f718fecc09a3533235eaa911dda5a0 Reviewed-by: Paul Wicking --- examples/network/doc/src/blockingfortuneclient.qdoc | 2 +- examples/network/doc/src/fortuneclient.qdoc | 2 +- examples/network/doc/src/fortuneserver.qdoc | 2 +- examples/network/doc/src/http.qdoc | 2 +- examples/network/doc/src/multicastreceiver.qdoc | 2 +- examples/network/doc/src/multicastsender.qdoc | 2 +- examples/network/doc/src/threadedfortuneserver.qdoc | 2 +- examples/widgets/doc/src/analogclock.qdoc | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/examples/network/doc/src/blockingfortuneclient.qdoc b/examples/network/doc/src/blockingfortuneclient.qdoc index 5255aa0ef34..cd7a8e4c9aa 100644 --- a/examples/network/doc/src/blockingfortuneclient.qdoc +++ b/examples/network/doc/src/blockingfortuneclient.qdoc @@ -4,7 +4,7 @@ /*! \example blockingfortuneclient \title Blocking Fortune Client - \meta category {Networking} + \examplecategory {Networking} \meta tags {tcp,network,threading,synchronous-io} \ingroup examples-network \brief Demonstrates how to create a client for a network service. diff --git a/examples/network/doc/src/fortuneclient.qdoc b/examples/network/doc/src/fortuneclient.qdoc index a62d62141b1..c22641940c4 100644 --- a/examples/network/doc/src/fortuneclient.qdoc +++ b/examples/network/doc/src/fortuneclient.qdoc @@ -4,7 +4,7 @@ /*! \example fortuneclient \title Fortune Client - \meta category {Networking} + \examplecategory {Networking} \meta tags {tcp,network} \ingroup examples-network \brief Demonstrates how to create a client for a network service. diff --git a/examples/network/doc/src/fortuneserver.qdoc b/examples/network/doc/src/fortuneserver.qdoc index 7007ca8fab7..1973f372cef 100644 --- a/examples/network/doc/src/fortuneserver.qdoc +++ b/examples/network/doc/src/fortuneserver.qdoc @@ -4,7 +4,7 @@ /*! \example fortuneserver \title Fortune Server - \meta category {Networking} + \examplecategory {Networking} \meta tags {tcp,network,server} \ingroup examples-network \brief Demonstrates how to create a server for a network service. diff --git a/examples/network/doc/src/http.qdoc b/examples/network/doc/src/http.qdoc index 8742c7ddf5c..0dcaffd42b9 100644 --- a/examples/network/doc/src/http.qdoc +++ b/examples/network/doc/src/http.qdoc @@ -3,7 +3,7 @@ /*! \example http - \meta category {Networking} + \examplecategory {Networking} \meta tags {http,network,https,proxy} \title HTTP Client \ingroup examples-network diff --git a/examples/network/doc/src/multicastreceiver.qdoc b/examples/network/doc/src/multicastreceiver.qdoc index 4b93e833147..16c7235c179 100644 --- a/examples/network/doc/src/multicastreceiver.qdoc +++ b/examples/network/doc/src/multicastreceiver.qdoc @@ -4,7 +4,7 @@ /*! \example multicastreceiver \title Multicast Receiver - \meta category {Networking} + \examplecategory {Networking} \meta tags {network,multicast,ipv6,ipv4,udp} \ingroup examples-network \brief Demonstrates how to receive information sent to a multicast group. diff --git a/examples/network/doc/src/multicastsender.qdoc b/examples/network/doc/src/multicastsender.qdoc index b067c65af57..26e0d951fe7 100644 --- a/examples/network/doc/src/multicastsender.qdoc +++ b/examples/network/doc/src/multicastsender.qdoc @@ -4,7 +4,7 @@ /*! \example multicastsender \title Multicast Sender - \meta category {Networking} + \examplecategory {Networking} \meta tags {network,multicast,ipv6,ipv4,udp} \ingroup examples-network \brief Demonstrates how to send messages to a multicast group. diff --git a/examples/network/doc/src/threadedfortuneserver.qdoc b/examples/network/doc/src/threadedfortuneserver.qdoc index 368e3366314..51198061e6e 100644 --- a/examples/network/doc/src/threadedfortuneserver.qdoc +++ b/examples/network/doc/src/threadedfortuneserver.qdoc @@ -4,7 +4,7 @@ /*! \example threadedfortuneserver \title Threaded Fortune Server - \meta category {Networking} + \examplecategory {Networking} \meta tags {tcp,network,threading,server,synchronous-io} \ingroup examples-network diff --git a/examples/widgets/doc/src/analogclock.qdoc b/examples/widgets/doc/src/analogclock.qdoc index 2b318a3778d..27d14be8097 100644 --- a/examples/widgets/doc/src/analogclock.qdoc +++ b/examples/widgets/doc/src/analogclock.qdoc @@ -3,7 +3,7 @@ /*! \example widgets/analogclock - \meta category {Graphics} + \examplecategory {Graphics} \meta tags {widgets} \title Analog Clock