From 303d26c6d1c5e87e2e0d1f0032b28a6a50edee03 Mon Sep 17 00:00:00 2001
From: Nico Vertriest <nico.vertriest@qt.io>
Date: Wed, 2 Oct 2019 14:22:12 +0200
Subject: [PATCH] Doc: Add doc for the \dontdocument command
Task-number: QTBUG-78936
Change-Id: Ia8635aa1b2d2ce97e5c1390bcdd7a5c920d87e83
Reviewed-by: Martin Smith <martin.smith@qt.io>
---
src/qdoc/doc/qdoc-manual-contextcmds.qdoc | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
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
--
GitLab