Commit 303d26c6 authored by Nico Vertriest's avatar Nico Vertriest
Browse files

Doc: Add doc for the \dontdocument command


Task-number: QTBUG-78936
Change-Id: Ia8635aa1b2d2ce97e5c1390bcdd7a5c920d87e83
Reviewed-by: default avatarMartin Smith <martin.smith@qt.io>
Showing with 18 additions and 0 deletions
......@@ -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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment