summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3dcollision-module.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-27 12:17:53 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2015-10-28 13:19:51 +0000
commit09ba2f8b9c360ad4d3cf8ebb04fbfc9c1c57cbe7 (patch)
tree07817ea591e07878b82b1708ea4bf5ae1707ed71 /src/doc/src/qt3dcollision-module.qdoc
parentf108a1a68adad19ab99bb9a523c2d7cf6c697b52 (diff)
Doc: Move the doc artifacts outside of the submodule directory
The qdocconf now lives in 'src/doc' because the documentation project defined by it covers the whole Qt 3D module. This change enables qmake to use 'qt3d' as the output directory for doc make targets. The new 'doc' directory also includes the relevant images, snippets, and the qdoc files. Change-Id: Ibc6d0912f8b1e665767e97630b3e5509e10c5710 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/doc/src/qt3dcollision-module.qdoc')
-rw-r--r--src/doc/src/qt3dcollision-module.qdoc74
1 files changed, 74 insertions, 0 deletions
diff --git a/src/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc
new file mode 100644
index 000000000..6c7151128
--- /dev/null
+++ b/src/doc/src/qt3dcollision-module.qdoc
@@ -0,0 +1,74 @@
+/****************************************************************************
+**
+** 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 Qt3DCollision
+ \title Qt3D Collision C++ Classes
+ \brief The Qt3D Collision module enables collision detection.
+ \ingroup modules
+ \ingroup qt3d-modules
+ \qtvariable 3dcollision
+
+ To use classes from this module, add this directive into the C++ files:
+
+ \code
+ #include <Qt3DCollision>
+ \endcode
+
+ To link against the corresponding C++ libraries, add the following to your qmake project file:
+
+ \badcode
+ QT += 3dcollision
+ \endcode
+
+*/
+
+/*!
+ \namespace Qt3DCollision
+ \inmodule Qt3DCollision
+ \ingroup qt3d-namespaces
+
+ \brief Contains classes that enable collision detection.
+*/
+
+/*!
+ \qmlmodule Qt3D.Collision 2.0
+ \title Qt3D Collision QML Types
+ \ingroup qmlmodules
+ \ingroup qt3d-qmlmodules
+
+ \brief Provides QML types to synchronize frames with the 3D backend.
+
+ To import and use the module's QML types, use the following statement:
+
+ \badcode
+ import Qt3D.Collision 2.0
+ \endcode
+
+ \section1 QML Types
+*/
+