summaryrefslogtreecommitdiffstats
path: root/src/collision
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-22 15:40:21 +0200
committerVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-27 13:21:59 +0000
commitd954056627d34907eeee6bba10ddf2e792d90140 (patch)
tree7d446091c193011540eb044b2d89bfed3c15d224 /src/collision
parent31a4c1e3438bc47ac9d488f557f6144f0a7463ba (diff)
Doc: Updated the docs for the namespace changes
Each of the submodules now have there own namespace so the following changes are required to adapt: - Added \namespace docs for the new namespaces. - Updated all the \class and \instantiates entries to use the appropriate namespace qualifier. - Changed the \module and \qmlmodule names for Qt 3D Core and Qt 3D Render modules. - Added the missing \module and \qmlmodule pages for the Qt 3D Collision module. Change-Id: Ibc5bf30e4f50aecb6a3b24bc8536f17ed19d681d Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/collision')
-rw-r--r--src/collision/doc/src/qt3dcollision-module.qdoc74
-rw-r--r--src/collision/qabstractcollider.cpp2
-rw-r--r--src/collision/qboxcollider.cpp6
-rw-r--r--src/collision/qcapsulecollider.cpp6
-rw-r--r--src/collision/qcollisionaspect.cpp2
-rw-r--r--src/collision/qspherecollider.cpp6
6 files changed, 85 insertions, 11 deletions
diff --git a/src/collision/doc/src/qt3dcollision-module.qdoc b/src/collision/doc/src/qt3dcollision-module.qdoc
new file mode 100644
index 000000000..6c7151128
--- /dev/null
+++ b/src/collision/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
+*/
+
diff --git a/src/collision/qabstractcollider.cpp b/src/collision/qabstractcollider.cpp
index 8a549f8a6..f9ed5a943 100644
--- a/src/collision/qabstractcollider.cpp
+++ b/src/collision/qabstractcollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QAbstractColliderPrivate
+ \class Qt3DCollision::QAbstractColliderPrivate
\internal
*/
QAbstractColliderPrivate::QAbstractColliderPrivate()
diff --git a/src/collision/qboxcollider.cpp b/src/collision/qboxcollider.cpp
index abb70908f..a1fa76e21 100644
--- a/src/collision/qboxcollider.cpp
+++ b/src/collision/qboxcollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QBoxColliderPrivate
+ \class Qt3DCollision::QBoxColliderPrivate
\internal
*/
QBoxColliderPrivate::QBoxColliderPrivate()
@@ -53,7 +53,7 @@ QBoxColliderPrivate::QBoxColliderPrivate()
}
/*!
- \class Qt3DCore::QBoxCollider
+ \class Qt3DCollision::QBoxCollider
\inmodule Qt3DCollision
\since 5.5
\brief Represents a box used for collision detection
@@ -62,7 +62,7 @@ QBoxColliderPrivate::QBoxColliderPrivate()
/*!
\qmltype BoxCollider
\inqmlmodule Qt3D.Collision
- \instantiates Qt3DCore::QBoxCollider
+ \instantiates Qt3DCollision::QBoxCollider
\inherits Component3D
\since 5.5
*/
diff --git a/src/collision/qcapsulecollider.cpp b/src/collision/qcapsulecollider.cpp
index 3c1a5f45e..c9aadd33b 100644
--- a/src/collision/qcapsulecollider.cpp
+++ b/src/collision/qcapsulecollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QCapsuleColliderPrivate
+ \class Qt3DCollision::QCapsuleColliderPrivate
\internal
*/
QCapsuleColliderPrivate::QCapsuleColliderPrivate()
@@ -55,7 +55,7 @@ QCapsuleColliderPrivate::QCapsuleColliderPrivate()
}
/*!
- \class Qt3DCore::QCapsuleCollider
+ \class Qt3DCollision::QCapsuleCollider
\inmodule Qt3DCollision
\since 5.5
\brief Represents a capsule used for collision detection
@@ -64,7 +64,7 @@ QCapsuleColliderPrivate::QCapsuleColliderPrivate()
/*!
\qmltype CapsuleCollider
\inqmlmodule Qt3D.Collision
- \instantiates Qt3DCore::QCapsuleCollider
+ \instantiates Qt3DCollision::QCapsuleCollider
\inherits Component3D
\since 5.5
*/
diff --git a/src/collision/qcollisionaspect.cpp b/src/collision/qcollisionaspect.cpp
index 3224d185a..f09a5c1f5 100644
--- a/src/collision/qcollisionaspect.cpp
+++ b/src/collision/qcollisionaspect.cpp
@@ -54,7 +54,7 @@ using namespace Qt3DCore;
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QCollisionAspectPrivate
+ \class Qt3DCollision::QCollisionAspectPrivate
\internal
*/
QCollisionAspectPrivate::QCollisionAspectPrivate()
diff --git a/src/collision/qspherecollider.cpp b/src/collision/qspherecollider.cpp
index 67bcdc1bf..1f038da51 100644
--- a/src/collision/qspherecollider.cpp
+++ b/src/collision/qspherecollider.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
namespace Qt3DCollision {
/*!
- \class Qt3DCore::QSphereColliderPrivate
+ \class Qt3DCollision::QSphereColliderPrivate
\internal
*/
QSphereColliderPrivate::QSphereColliderPrivate()
@@ -53,7 +53,7 @@ QSphereColliderPrivate::QSphereColliderPrivate()
}
/*!
- \class Qt3DCore::QSphereCollider
+ \class Qt3DCollision::QSphereCollider
\inmodule Qt3DCollision
\since 5.5
\brief Represents a sphere used for collision detection
@@ -62,7 +62,7 @@ QSphereColliderPrivate::QSphereColliderPrivate()
/*!
\qmltype SphereCollider
\inqmlmodule Qt3D.Collision
- \instantiates Qt3DCore::QSphereCollider
+ \instantiates Qt3DCollision::QSphereCollider
\inherits Component3D
\since 5.5
*/