diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-02-07 13:21:09 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-02-09 12:07:25 +0000 |
commit | c8964b8f1cf56718a189b0f57bad446cec30a8b8 (patch) | |
tree | 221f917586c8c50f862361cc7c41e0865499e4ef /src/doc/src/qt3dinput-module.qdoc | |
parent | c8a48a9a28889598cb2a06fc8d5deb9b803509ca (diff) |
Doc: Divide documentation into submodules
QDoc in Qt 5.11 will use Clang (libclang) to parse C++ documentation.
In order to do that, Clang needs to have the include paths available
when parsing source; qmake provides that information to QDoc but only
when the documentation project is located under the correct module
(source) path.
By having dedicated doc projects for Qt 3D Core, Render, Input, etc.
the number of documentation warnings is signicantly reduced. A
top-level 'Qt 3D' project is still kept, and contains the landing page,
overview, examples, and top-level 'C++ classes' and 'QML types' pages
that list all types documented across all Qt 3D submodules.
Change-Id: Id5936de36f31c2a8764a64e1e9d7ae0d10e8ab14
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/doc/src/qt3dinput-module.qdoc')
-rw-r--r-- | src/doc/src/qt3dinput-module.qdoc | 75 |
1 files changed, 0 insertions, 75 deletions
diff --git a/src/doc/src/qt3dinput-module.qdoc b/src/doc/src/qt3dinput-module.qdoc deleted file mode 100644 index b14380e3a..000000000 --- a/src/doc/src/qt3dinput-module.qdoc +++ /dev/null @@ -1,75 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 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$ -** -****************************************************************************/ - -/*! - \module Qt3DInput - \title Qt 3D Input C++ Classes - \brief The Qt 3D Input module provides classes for handling user input in - applications using Qt3D. - - \ingroup modules - \ingroup qt3d-modules - \qtvariable 3dinput - - To use classes from this module, add this directive into the C++ files: - - \code - #include <Qt3DInput> - \endcode - - To link against the corresponding C++ libraries, add the following to your qmake project file: - - \badcode - QT += 3dinput - \endcode -*/ - -/*! - \namespace Qt3DInput - \inmodule Qt3DInput - \ingroup qt3d-namespaces - - \brief Contains classes that enable user input. -*/ - -/*! - \qmlmodule Qt3D.Input 2.0 - \title Qt 3D Input QML Types - \ingroup qmlmodules - \ingroup qt3d-qmlmodules - - \brief Provides QML types for Qt 3D user input. - - To import and use the module's QML types, use the following statement: - - \badcode - import Qt3D.Input 2.0 - \endcode - - \section1 QML Types -*/ - |