diff options
| author | Nico Vertriest <nico.vertriest@qt.io> | 2019-10-02 14:22:12 +0200 |
|---|---|---|
| committer | Nico Vertriest <nico.vertriest@qt.io> | 2019-10-02 14:49:57 +0200 |
| commit | 303d26c6d1c5e87e2e0d1f0032b28a6a50edee03 (patch) | |
| tree | c3e56b583d0c467aa05938a6a5a541de732e3ca6 | |
| parent | c8e79294237260d735324663932a676d8084efcb (diff) | |
| download | qttools-303d26c6d1c5e87e2e0d1f0032b28a6a50edee03.tar.gz | |
Doc: Add doc for the \dontdocument command
Task-number: QTBUG-78936
Change-Id: Ia8635aa1b2d2ce97e5c1390bcdd7a5c920d87e83
Reviewed-by: Martin Smith <martin.smith@qt.io>
| -rw-r--r-- | src/qdoc/doc/qdoc-manual-contextcmds.qdoc | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc index 2fef88099..61e29669c 100644 --- a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -237,6 +237,24 @@ See how QDoc renders this property on the reference page for the \l {State::changes}{State} type. + \target dontdocument-command + \section1 \\dontdocument + + The \\dontdocument command is only used in a dontdocument.qdoc file + for a particular module. This file specifies publically declared + classes or structs that are not meant to be documented. Then QDoc will + not print warnings about missing \class comments for these classes + and structs. + + Below you will find the \\dontdocument command in the + dontdocument.qdoc for widgets: + + \code + /*! + \dontdocument (QTypeInfo QMetaTypeId) + */ + \endcode + \target obsolete-command \section1 \\obsolete |