1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Use the \examplecategory macro to tag examples

Browse Source 
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 <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2023-04-11 12:02:10 +00:00
parent f334a22eae
commit 45ca5c8585
8 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
examples/network/doc/src/blockingfortuneclient.qdoc
View File

@ -4,7 +4,7 @@
/*! /*!
\example blockingfortuneclient \example blockingfortuneclient
\title Blocking Fortune Client \title Blocking Fortune Client
\meta category {Networking} \examplecategory {Networking}
\meta tags {tcp,network,threading,synchronous-io} \meta tags {tcp,network,threading,synchronous-io}
\ingroup examples-network \ingroup examples-network
\brief Demonstrates how to create a client for a network service. \brief Demonstrates how to create a client for a network service.

2
examples/network/doc/src/fortuneclient.qdoc
View File

@ -4,7 +4,7 @@
/*! /*!
\example fortuneclient \example fortuneclient
\title Fortune Client \title Fortune Client
\meta category {Networking} \examplecategory {Networking}
\meta tags {tcp,network} \meta tags {tcp,network}
\ingroup examples-network \ingroup examples-network
\brief Demonstrates how to create a client for a network service. \brief Demonstrates how to create a client for a network service.

2
examples/network/doc/src/fortuneserver.qdoc
View File

@ -4,7 +4,7 @@
/*! /*!
\example fortuneserver \example fortuneserver
\title Fortune Server \title Fortune Server
\meta category {Networking} \examplecategory {Networking}
\meta tags {tcp,network,server} \meta tags {tcp,network,server}
\ingroup examples-network \ingroup examples-network
\brief Demonstrates how to create a server for a network service. \brief Demonstrates how to create a server for a network service.

2
examples/network/doc/src/http.qdoc
View File

@ -3,7 +3,7 @@
/*! /*!
\example http \example http
\meta category {Networking} \examplecategory {Networking}
\meta tags {http,network,https,proxy} \meta tags {http,network,https,proxy}
\title HTTP Client \title HTTP Client
\ingroup examples-network \ingroup examples-network

2
examples/network/doc/src/multicastreceiver.qdoc
View File

@ -4,7 +4,7 @@
/*! /*!
\example multicastreceiver \example multicastreceiver
\title Multicast Receiver \title Multicast Receiver
\meta category {Networking} \examplecategory {Networking}
\meta tags {network,multicast,ipv6,ipv4,udp} \meta tags {network,multicast,ipv6,ipv4,udp}
\ingroup examples-network \ingroup examples-network
\brief Demonstrates how to receive information sent to a multicast group. \brief Demonstrates how to receive information sent to a multicast group.

2
examples/network/doc/src/multicastsender.qdoc
View File

@ -4,7 +4,7 @@
/*! /*!
\example multicastsender \example multicastsender
\title Multicast Sender \title Multicast Sender
\meta category {Networking} \examplecategory {Networking}
\meta tags {network,multicast,ipv6,ipv4,udp} \meta tags {network,multicast,ipv6,ipv4,udp}
\ingroup examples-network \ingroup examples-network
\brief Demonstrates how to send messages to a multicast group. \brief Demonstrates how to send messages to a multicast group.

2
examples/network/doc/src/threadedfortuneserver.qdoc
View File

@ -4,7 +4,7 @@
/*! /*!
\example threadedfortuneserver \example threadedfortuneserver
\title Threaded Fortune Server \title Threaded Fortune Server
\meta category {Networking} \examplecategory {Networking}
\meta tags {tcp,network,threading,server,synchronous-io} \meta tags {tcp,network,threading,server,synchronous-io}
\ingroup examples-network \ingroup examples-network

2
examples/widgets/doc/src/analogclock.qdoc
View File

@ -3,7 +3,7 @@
/*! /*!
\example widgets/analogclock \example widgets/analogclock
\meta category {Graphics} \examplecategory {Graphics}
\meta tags {widgets} \meta tags {widgets}
\title Analog Clock \title Analog Clock