From a5f6f3f710fc9de3f8b9d4685e22c9c8912b11d9 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Tue, 11 Apr 2023 10:53:39 +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.

Pick-to: 6.5
Task-number: QTBUG-112731
Change-Id: Ia1b34175e10109eef055b2759705f0ca0521179a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
---
 examples/websockets/doc/echoclient.qdoc         | 2 +-
 examples/websockets/doc/echoserver.qdoc         | 2 +-
 examples/websockets/doc/examples.qdoc           | 2 +-
 examples/websockets/doc/qmlwebsocketclient.qdoc | 2 +-
 examples/websockets/doc/qmlwebsocketserver.qdoc | 2 +-
 examples/websockets/doc/simplechat.qdoc         | 2 +-
 examples/websockets/doc/sslechoclient.qdoc      | 2 +-
 examples/websockets/doc/sslechoserver.qdoc      | 2 +-
 8 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'examples')

diff --git a/examples/websockets/doc/echoclient.qdoc b/examples/websockets/doc/echoclient.qdoc
index 1f328f0..871a916 100644
--- a/examples/websockets/doc/echoclient.qdoc
+++ b/examples/websockets/doc/echoclient.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example echoclient
     \title WebSocket Echo Client
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief Show how to write a simple WebSocket client application.
 
diff --git a/examples/websockets/doc/echoserver.qdoc b/examples/websockets/doc/echoserver.qdoc
index 0728372..470474f 100644
--- a/examples/websockets/doc/echoserver.qdoc
+++ b/examples/websockets/doc/echoserver.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example echoserver
     \title WebSocket Echo Server
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief Show how to write a simple WebSocket server application.
 
diff --git a/examples/websockets/doc/examples.qdoc b/examples/websockets/doc/examples.qdoc
index d22d8e5..6f23498 100644
--- a/examples/websockets/doc/examples.qdoc
+++ b/examples/websockets/doc/examples.qdoc
@@ -5,7 +5,7 @@
 /*!
     \group qtwebsockets-examples
     \title Qt WebSockets Examples
-    \meta category {Networking}
+    \examplecategory {Networking}
     \brief List of Qt WebSocket examples
 
     The examples below can be used as a guide to using the \l{Qt WebSockets} API.
diff --git a/examples/websockets/doc/qmlwebsocketclient.qdoc b/examples/websockets/doc/qmlwebsocketclient.qdoc
index e5770f2..b3da626 100644
--- a/examples/websockets/doc/qmlwebsocketclient.qdoc
+++ b/examples/websockets/doc/qmlwebsocketclient.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example qmlwebsocketclient
     \title QML WebSocket Client
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief Explains how to write a QML WebSocket client example.
 
diff --git a/examples/websockets/doc/qmlwebsocketserver.qdoc b/examples/websockets/doc/qmlwebsocketserver.qdoc
index 8582384..099d6d6 100644
--- a/examples/websockets/doc/qmlwebsocketserver.qdoc
+++ b/examples/websockets/doc/qmlwebsocketserver.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example qmlwebsocketserver
     \title QML WebSocket Server
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief A simple example that shows how to use a QML WebSocketServer.
 
diff --git a/examples/websockets/doc/simplechat.qdoc b/examples/websockets/doc/simplechat.qdoc
index 907cd30..a89ab4b 100644
--- a/examples/websockets/doc/simplechat.qdoc
+++ b/examples/websockets/doc/simplechat.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example simplechat
     \title Simple WebSocket Chat
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief A minimal chat application using the WebSocket protocol.
 
diff --git a/examples/websockets/doc/sslechoclient.qdoc b/examples/websockets/doc/sslechoclient.qdoc
index 4213722..c6766aa 100644
--- a/examples/websockets/doc/sslechoclient.qdoc
+++ b/examples/websockets/doc/sslechoclient.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example sslechoclient
     \title Secure WebSocket Echo Client
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief A simple client application using secure WebSockets (wss).
 
diff --git a/examples/websockets/doc/sslechoserver.qdoc b/examples/websockets/doc/sslechoserver.qdoc
index b5b348a..41ab060 100644
--- a/examples/websockets/doc/sslechoserver.qdoc
+++ b/examples/websockets/doc/sslechoserver.qdoc
@@ -4,7 +4,7 @@
 /*!
     \example sslechoserver
     \title Secure WebSocket Echo Server
-    \meta category {Networking}
+    \examplecategory {Networking}
     \ingroup qtwebsockets-examples
     \brief A simple server to respond to clients over secure WebSockets (wss).
 
-- 
cgit v1.2.1