summaryrefslogtreecommitdiffstats
path: root/src/platformheaders/doc/src
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2019-05-07 10:56:08 +0200
committerMartin Smith <martin.smith@qt.io>2019-05-07 16:58:09 +0200
commit0e2c013a4523915a0af37fe1f338a4f66b07f91d (patch)
treecaf9974c666f8b3db67fc7a564b416e543fbb635 /src/platformheaders/doc/src
parent91ab70d17f892f3ff6b2019632fda3920d045dcb (diff)
doc: Add dontdocument.qdoc files
Each module that has publically declared classes or structs that are not meant to be documented is given a dontdocument.qdoc file to tell qdoc that these classes are not meant to be documentented. Then qdoc will not print warnings about missing \class comments for these classes and structs. Change-Id: I9195f0b546032e1c7642c9da34d85a0a4a9bfb08 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/platformheaders/doc/src')
-rw-r--r--src/platformheaders/doc/src/dontdocument.qdoc30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/platformheaders/doc/src/dontdocument.qdoc b/src/platformheaders/doc/src/dontdocument.qdoc
new file mode 100644
index 0000000000..dc02c6473e
--- /dev/null
+++ b/src/platformheaders/doc/src/dontdocument.qdoc
@@ -0,0 +1,30 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \dontdocument (QMetaTypeId)
+*/