summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src/qt3dinput-module.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/doc/src/qt3dinput-module.qdoc')
-rw-r--r--src/core/doc/src/qt3dinput-module.qdoc67
1 files changed, 67 insertions, 0 deletions
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
+*/
+