diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-06-12 15:53:11 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-06-15 11:16:18 +0000 |
commit | 6f93508bcd38d8d0fa524ac00d65b518fac0d82a (patch) | |
tree | 05c421e47f3de4360598a3710adbebe3493bceba /src/core/doc | |
parent | ddf59ad0d0cf6e81b8e7fa821f0466937bc143aa (diff) |
Doc: Add skeleton docs for Qt3D Input classes and QML types
Not fully documented yet, but enables the classes and QML types to be
visible in the documentation.
Change-Id: I557aeae9ff6314b697bcc9313c1061543363b645
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/core/doc')
-rw-r--r-- | src/core/doc/qt3dcore.qdocconf | 7 | ||||
-rw-r--r-- | src/core/doc/src/qt3dinput-module.qdoc | 67 |
2 files changed, 72 insertions, 2 deletions
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index 251c0ab67..65e6e03fe 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -36,11 +36,13 @@ depends += qtcore qtqml qtquick qtdoc qt3drenderer headerdirs += .. \ ../../plugins \ - ../../quick3d/quick3d + ../../quick3d/quick3d \ + ../../input sourcedirs += .. \ ../../plugins \ - ../../quick3d/quick3d + ../../quick3d/quick3d \ + ../../input exampledirs += src/snippets @@ -49,6 +51,7 @@ exampledirs += src/snippets imagedirs += images Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \ + QT3DINPUTSHARED_EXPORT \ QT3DCORESHARED_EXPORT Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY diff --git a/src/core/doc/src/qt3dinput-module.qdoc b/src/core/doc/src/qt3dinput-module.qdoc new file mode 100644 index 000000000..b82de6862 --- /dev/null +++ b/src/core/doc/src/qt3dinput-module.qdoc @@ -0,0 +1,67 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module Qt3DInput + \title Qt3D Input C++ Classes + \brief The Qt3D 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 +*/ + +/*! + \qmlmodule Qt3D.Input 2.0 + \title Qt3D Input QML Types + \ingroup qmlmodules + \ingroup qt3d-qmlmodules + + \brief Provides QML types for Qt3D 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 +*/ + |