diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-04-15 14:33:13 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2020-04-20 18:57:51 +0200 |
commit | 1f6868682c19c10889ad9239412b389689eafbde (patch) | |
tree | c3e171875016126e3e5f5e4500ad3045d58c957c | |
parent | 0214ec3e091f69bd9b8ebeed2bc9a6cd88882059 (diff) | |
download | qttools-1f6868682c19c10889ad9239412b389689eafbde.tar.gz |
Doc: QDoc Manual: Document \readonly and \inheaderfile commands
Fixes: QTBUG-65585
Fixes: QTBUG-68280
Change-Id: I7843e2d597e27c2d46ffcafe67b6bfd624770455
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r-- | src/qdoc/doc/qdoc-manual-cmdindex.qdoc | 2 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-contextcmds.qdoc | 36 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-topiccmds.qdoc | 2 |
3 files changed, 39 insertions, 1 deletions
diff --git a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc index 77a3266fb..430fdf0f8 100644 --- a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc +++ b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc @@ -68,6 +68,7 @@ \li \l {image-command} {\\image} \li \l {include-command} {\\include} \li \l {ingroup-command} {\\ingroup} + \li \l {inheaderfile-command}{\\inheaderfile} \li \l {inherits-command}{\\inherits} \li \l {inlineimage-command} {\\inlineimage} \li \l {inmodule-command} {\\inmodule} @@ -117,6 +118,7 @@ \li \l {quotefile-command} {\\quotefile} \li \l {quotefromfile-command} {\\quotefromfile} \li \l {raw-command} {\\raw} + \li \l {readonly-command} {\\readonly} \li \l {reentrant-command} {\\reentrant} \li \l {reimp-command} {\\reimp} \li \l {relates-command} {\\relates} diff --git a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc index 3d69e76a6..52f27290f 100644 --- a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -37,7 +37,8 @@ \list \li Is this class thread-safe? \li Is this function reentrant? - \li Of which module is this class a member ? + \li Of which module is this class a member? + \li Which include statement is needed to use this class? \endlist Context commands can appear anywhere in a QDoc comment, @@ -47,6 +48,7 @@ \list \li \l {abstract-command} {\\abstract} \li \l {ingroup-command}{\\ingroup}, + \li \l {inheaderfile-command}{\\inheaderfile}, \li \l {inherits-command}{\\inherits}, \li \l {inmodule-command}{\\inmodule}, \li \l {internal-command}{\\internal}, @@ -57,6 +59,7 @@ \li \l {preliminary-command}{\\preliminary}, \li \l {previouspage-command}{\\previouspage}, \li \l {qmlabstract-command} {\\qmlabstract} + \li \l {readonly-command} {\\readonly} \li \l {reentrant-command}{\\reentrant}, \li \l {reimp-command}{\\reimp}, \li \l {relates-command}{\\relates}, @@ -243,6 +246,31 @@ * / \endcode + \target inheaderfile-command + \section1 \\inheaderfile + + The \\inheaderfile meta-command is used for overriding the include statement + generated for a C++ class, namespace, or header file reference documentation. + + By default, QDoc documents a \c {\class SomeClass} to be available with + a following include statement: + + \code + #include <SomeClass> + \endcode + + If the actual include statement differs from the default, this can be + documented as + + \badcode + \class SomeClass + \inheaderfile Tools/SomeClass + ... + \endcode + + See also \l {class-command}{\\class} and + \l {headerfile-command}{\\headerfile}. + \target obsolete-command \section1 \\obsolete @@ -379,6 +407,12 @@ \endlist \endquotation + \target readonly-command + \section1 \\readonly + + The \\readonly command is used in conjunction with a \l {qmlproperty-command} + {\\qmlproperty} command to mark the QML property as read-only. + \target since-command \section1 \\since diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc index 09eddad00..8e142f5af 100644 --- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -664,6 +664,8 @@ ... \endquotation + See also \l {inheaderfile-command}{\\inheaderfile}. + \target macro-command \section1 \\macro |