summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-04-11 11:08:09 +0000
committerTopi Reinio <topi.reinio@qt.io>2023-04-11 13:34:44 +0000
commitb519fe95fdb2dde80b37d5ddc42234e7ed9f6d26 (patch)
treee30ccf67be51b4783ace46de83956930ff30f42d
parentc82b7875dace40f15dbced1bc91770e5557c30de (diff)
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: I38b38c524b35ad4c0049f2978f5fc65d03c6a1cd Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--examples/grpc/doc/src/chat.qdoc2
-rw-r--r--examples/grpc/doc/src/magic8ball.qdoc2
-rw-r--r--examples/protobuf/sensors/doc/sensors.qdoc2
3 files changed, 3 insertions, 3 deletions
diff --git a/examples/grpc/doc/src/chat.qdoc b/examples/grpc/doc/src/chat.qdoc
index dbac0a6..b5ec791 100644
--- a/examples/grpc/doc/src/chat.qdoc
+++ b/examples/grpc/doc/src/chat.qdoc
@@ -4,7 +4,7 @@
/*!
\example chat
\ingroup qtgrpc-examples
- \meta category {Networking}
+ \examplecategory {Networking}
\meta tag {network,protobuf,grpc,serialization,tcp}
\title Chat
diff --git a/examples/grpc/doc/src/magic8ball.qdoc b/examples/grpc/doc/src/magic8ball.qdoc
index 0383e76..90ae802 100644
--- a/examples/grpc/doc/src/magic8ball.qdoc
+++ b/examples/grpc/doc/src/magic8ball.qdoc
@@ -4,7 +4,7 @@
/*!
\example magic8ball
\ingroup qtgrpc-examples
- \meta category {Networking}
+ \examplecategory {Networking}
\meta tag {network,protobuf,grpc}
\title Magic 8 Ball
diff --git a/examples/protobuf/sensors/doc/sensors.qdoc b/examples/protobuf/sensors/doc/sensors.qdoc
index 5676910..498fd7d 100644
--- a/examples/protobuf/sensors/doc/sensors.qdoc
+++ b/examples/protobuf/sensors/doc/sensors.qdoc
@@ -5,7 +5,7 @@
\example sensors
\ingroup qtprotobuf-examples
\meta tag {network,protobuf,serialization,udp}
- \meta category {Networking}
+ \examplecategory {Networking}
\title Sensors
\brief The Sensors example shows how two applications can communicate by