diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2022-09-27 15:22:26 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2022-09-29 10:51:12 +0200 |
| commit | 6713d066a8346d78a24ecbf6bbb1dff7fb57cf72 (patch) | |
| tree | 637a5b826a229e6f203287bb3e87ae1eb495ac10 | |
| parent | db830ae43414a4882bd263641dad07b0b23811d7 (diff) | |
Doc: QDoc Manual: Document the \wrapper command
This command is used in a number of OpenGL and Vulkan-related classes,
and it's sole purpose is to suppress warnings that QDoc would otherwise
generate for an undocumented, non-Qt API.
Pick-to: 6.4
Fixes: QTBUG-106255
Change-Id: I7146ecd1a904cf170907cbb184dd8d06cca9bb12
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-cmdindex.qdoc | 1 | ||||
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-contextcmds.qdoc | 9 |
2 files changed, 10 insertions, 0 deletions
diff --git a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc index dd72f63d6..ac39bc8f5 100644 --- a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc +++ b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc @@ -127,5 +127,6 @@ \li \l {variable-command} {\\variable} \li \l {value-command} {\\value} \li \l {warning-command} {\\warning} + \li \l {wrapper-command} {\\wrapper} \endlist */ diff --git a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc index 97cb22514..e93ab25bf 100644 --- a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -49,6 +49,7 @@ \li \l {subtitle-command}{\\subtitle} \li \l {threadsafe-command}{\\threadsafe} \li \l {title-command}{\\title} + \li \l {wrapper-command}{\\wrapper} \endlist */ @@ -529,6 +530,14 @@ marking specific C++ enum values with since information. See also \l {value-command}{\\value} and \l {ignoresince}. + + \target wrapper-command + \section1 \\wrapper + + The \\wrapper command, when used in a C++ class documentation, marks the + class as a \e wrapper that provides access to a non-Qt API. This command + is used for suppressing warnings that might otherwise be generated for + members of such a class. */ |