summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2019-10-05 03:00:41 +0200
committerQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2019-10-05 03:00:42 +0200
commit53c644e96b0e1166f70cf4694860fde3de9760e9 (patch)
tree68b977e3ce8ff7ed0617973fb2e3d88ed58fb2a5 /src
parent8107d60400f5e5d512246152e7ed35de71e51c6f (diff)
parent303d26c6d1c5e87e2e0d1f0032b28a6a50edee03 (diff)
Merge remote-tracking branch 'origin/5.13' into 5.14
Diffstat (limited to 'src')
-rw-r--r--src/qdoc/doc/qdoc-manual-contextcmds.qdoc18
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