diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2017-09-11 11:48:20 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2017-10-11 10:01:37 +0000 |
| commit | 9b2f166d7c94a8c4385fce1ce55513d677f981b3 (patch) | |
| tree | 441d035e10576276e5baccfc8a4dea91384d56d9 /src/qdoc/doc/qdoc-manual-topiccmds.qdoc | |
| parent | 4c5927c40b7c3d94308d5c20a0c79acbd9e4f104 (diff) | |
qdoc: Allow defining example tags with the \meta command
QDoc collects example metadata that includes tags, accessible in Qt
Creator's Welcome mode. These tags are automatically generated from
the example title and module name.
To allow writers to define additional tags to an example, \meta
command can be used within \example topic:
\example foo
\meta {tag} {QFoo,QBar} //! Demonstrates the use of these classes
Change-Id: I8f18d612567fc8e035d84663d9e2cdb953db11c6
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/qdoc/doc/qdoc-manual-topiccmds.qdoc')
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-topiccmds.qdoc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc index 53fe85684..b2ae67dbf 100644 --- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -409,7 +409,8 @@ \endquotation \b {See also:} \l {generatelist-command}{\\generatelist examplefiles}, - \l {noautolist-command}{\\noautolist} + \l {noautolist-command}{\\noautolist}, + \l {meta-command}{\\meta} \target externalpage-command \section1 \\externalpage |