summaryrefslogtreecommitdiffstats
path: root/src/doc/src
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2016-01-19 15:30:02 +0100
committerVenugopal Shivashankar <venugopal.shivashankar@digia.com>2016-01-21 15:33:27 +0000
commit44c743c90cf51eddbf5b0bb3cf957c58fa0ef94f (patch)
tree19c85080191a2023662b4c9fd43d20f9c1e5fb57 /src/doc/src
parentba467a2c4e44df7934792dfacaa8135c77a010c1 (diff)
Doc: Removed Qt3DCollision namespace and module docs
Besides that, fixed a few qdoc warnings. Change-Id: Ibaf8fd6ffbb93f3f2bd73fa5fedf06e94f6ac2eb Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/doc/src')
-rw-r--r--src/doc/src/qt3d-index.qdoc5
-rw-r--r--src/doc/src/qt3d-module.qdoc7
-rw-r--r--src/doc/src/qt3dcollision-module.qdoc74
3 files changed, 2 insertions, 84 deletions
diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index 4c2ce5a11..9c4255ac8 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
@@ -58,7 +58,7 @@
\l qmake \c .pro file:
\badcode
- QT += 3dcore 3drender 3dinput 3dcollision 3dlogic
+ QT += 3dcore 3drender 3dinput 3dlogic
\endcode
To include the definitions of the modules' classes, use the following
@@ -68,14 +68,13 @@
#include <Qt3DCore>
#include <Qt3DRender>
#include <Qt3DInput>
- #include <Qt3DCollision>
#include <Qt3DLogic>
\endcode
A Qt Quick application requires also additional dependencies:
\badcode
- QT += 3dcore 3drenderer 3dinput 3dcollision qml quick 3dquick
+ QT += 3dcore 3drenderer 3dinput qml quick 3dquick
\endcode
\section1 Overview
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index 90bbd5e86..264c258c3 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -63,9 +63,6 @@
\section2 Qt 3D Core Module
\generatelist {classesbymodule Qt3DCore}
- \section2 Qt 3D Collision Module
- \generatelist {classesbymodule Qt3DCollision}
-
\section2 Qt 3D Input Module
\generatelist {classesbymodule Qt3DInput}
@@ -104,7 +101,6 @@
following import statements:
\badcode
- import Qt3D.Collision 2.0
import Qt3D.Render 2.0
import Qt3D.Input 2.0
import Qt3D.Logic 2.0
@@ -115,9 +111,6 @@
\section2 Qt 3D Core Module
\generatelist {qmltypesbymodule Qt3D.Core}
- \section2 Qt 3D Collision Module
- \generatelist {qmltypesbymodule Qt3D.Collision}
-
\section2 Qt 3D Input Module
\generatelist {qmltypesbymodule Qt3D.Input}
diff --git a/src/doc/src/qt3dcollision-module.qdoc b/src/doc/src/qt3dcollision-module.qdoc
deleted file mode 100644
index 84ee787db..000000000
--- a/src/doc/src/qt3dcollision-module.qdoc
+++ /dev/null
@@ -1,74 +0,0 @@
-/****************************************************************************
-**
-** 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 Qt 3D Collision C++ Classes
- \brief The Qt 3D 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 Qt 3D 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
-*/
-