summaryrefslogtreecommitdiffstats
path: root/src/core/doc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-01 15:38:10 +0200
committerVenugopal Shivashankar <venugopal.shivashankar@digia.com>2015-10-05 08:47:51 +0000
commit60e82e5c6cfe785b1900ae9c4f93ea7b07f00008 (patch)
tree2a6fc588c457c4405d484ac94db04e6d4a4a8fff /src/core/doc
parent1663e2d030ddcf6f7e0ac1222705ac109211ae4c (diff)
Doc: Use a single a doc project for all the submodule docs
Although there are different headers and import statements to use for these submodules, it's still convenient for the reader with one doc project. Task-number: QTBUG-48502 Change-Id: I3103501fd272739a0fb8bfd8e0aa7d3f48e5df82 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/core/doc')
-rw-r--r--src/core/doc/qt3d.qdocconf81
-rw-r--r--src/core/doc/qt3dcore.qdocconf62
-rw-r--r--src/core/doc/src/qt3d-index.qdoc (renamed from src/core/doc/src/qt3dcore-index.qdoc)16
-rw-r--r--src/core/doc/src/qt3d-module.qdoc (renamed from src/core/doc/src/qt3dcore-module.qdoc)73
4 files changed, 155 insertions, 77 deletions
diff --git a/src/core/doc/qt3d.qdocconf b/src/core/doc/qt3d.qdocconf
new file mode 100644
index 000000000..042ee7814
--- /dev/null
+++ b/src/core/doc/qt3d.qdocconf
@@ -0,0 +1,81 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project = Qt3D
+description = Qt 3D Reference Documentation
+version = $QT_VERSION
+
+examplesinstallpath = qt3d
+
+qhp.projects = Qt3D
+
+qhp.Qt3D.file = qt3d.qhp
+qhp.Qt3D.namespace = org.qt-project.qt3d.$QT_VERSION_TAG
+qhp.Qt3D.virtualFolder = qt3d
+qhp.Qt3D.indexTitle = Qt 3D
+qhp.Qt3D.indexRoot =
+
+qhp.Qt3D.filterAttributes = qt3d $QT_VERSION qtrefdoc
+qhp.Qt3D.customFilters.Qt.name = Qt3D $QT_VERSION
+qhp.Qt3D.customFilters.Qt.filterAttributes = qt3d $QT_VERSION
+
+qhp.Qt3D.subprojects = classes qmltypes
+
+qhp.Qt3D.subprojects.classes.title = C++ Classes
+qhp.Qt3D.subprojects.classes.indexTitle = Qt 3D C++ Classes
+qhp.Qt3D.subprojects.classes.selectors = class fake:headerfile
+qhp.Qt3D.subprojects.classes.sortPages = true
+
+qhp.Qt3D.subprojects.qmltypes.title = QML Types
+qhp.Qt3D.subprojects.qmltypes.indexTitle = Qt 3D QML Types
+qhp.Qt3D.subprojects.qmltypes.selectors = qmlclass
+qhp.Qt3D.subprojects.qmltypes.sortPages = true
+
+tagfile = qt3d.tags
+
+depends += qtcore qtqml qtquick qtdoc
+
+headerdirs += .. \
+ ../../render \
+ ../../collision \
+ ../../logic \
+ ../../plugins \
+ ../../quick3d/quick3d \
+ ../../input
+
+
+sourcedirs += .. \
+ ../../render \
+ ../../collision \
+ ../../logic \
+ ../../plugins \
+ ../../quick3d/quick3d \
+ ../../input
+
+exampledirs += ../../../examples/qt3d \
+ src/snippets
+
+examples.fileextensions += "*.fraq *.geom *.vert"
+examples.imageextensions += "*.png"
+
+#excludedirs +=
+
+imagedirs += images \
+ ../../render/doc/images \
+ ../../../examples/qt3d/shadow-map-qml/doc/images \
+ ../../../examples/qt3d/basicshapes-cpp/doc/images \
+ ../../../examples/qt3d/planets-qml/doc/images \
+ ../../../examples/qt3d/wireframe/doc/images
+
+Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \
+ QT3DINPUTSHARED_EXPORT \
+ QT3DCORESHARED_EXPORT \
+ QT3DLOGIC_PRIVATE_EXPORT \
+ QT3DLOGICSHARED_EXPORT \
+ QT3DRENDERERSHARED_EXPORT \
+ QT3DRENDERERSHARED_PRIVATE_EXPORT
+
+Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
+
+navigation.landingpage = "Qt 3D"
+navigation.cppclassespage = "Qt 3D C++ Classes"
+navigation.qmltypespage = "Qt 3D QML Types"
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf
deleted file mode 100644
index 923cc1345..000000000
--- a/src/core/doc/qt3dcore.qdocconf
+++ /dev/null
@@ -1,62 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
-project = Qt3DCore
-description = Qt3D Core Reference Documentation
-version = $QT_VERSION
-
-examplesinstallpath = qt3d
-
-qhp.projects = Qt3DCore
-
-qhp.Qt3DCore.file = qt3dcore.qhp
-qhp.Qt3DCore.namespace = org.qt-project.qt3dcore.$QT_VERSION_TAG
-qhp.Qt3DCore.virtualFolder = qt3dcore
-qhp.Qt3DCore.indexTitle = Qt3D Module
-qhp.Qt3DCore.indexRoot =
-
-qhp.Qt3DCore.filterAttributes = qt3dcore $QT_VERSION qtrefdoc
-qhp.Qt3DCore.customFilters.Qt.name = Qt3DCore $QT_VERSION
-qhp.Qt3DCore.customFilters.Qt.filterAttributes = qt3dcore $QT_VERSION
-
-qhp.Qt3DCore.subprojects = classes qmltypes
-
-qhp.Qt3DCore.subprojects.classes.title = C++ Classes
-qhp.Qt3DCore.subprojects.classes.indexTitle = Qt3D Core C++ Classes
-qhp.Qt3DCore.subprojects.classes.selectors = class fake:headerfile
-qhp.Qt3DCore.subprojects.classes.sortPages = true
-
-qhp.Qt3DCore.subprojects.qmltypes.title = QML Types
-qhp.Qt3DCore.subprojects.qmltypes.indexTitle = Qt3D Core QML Types
-qhp.Qt3DCore.subprojects.qmltypes.selectors = qmlclass
-qhp.Qt3DCore.subprojects.qmltypes.sortPages = true
-
-tagfile = ../../../doc/qt3dcore/qt3dcore.tags
-
-depends += qtcore qtqml qtquick qtdoc qt3drenderer
-
-headerdirs += .. \
- ../../plugins \
- ../../quick3d/quick3d \
- ../../input
-
-sourcedirs += .. \
- ../../plugins \
- ../../quick3d/quick3d \
- ../../input
-
-exampledirs += src/snippets
-
-#excludedirs +=
-
-imagedirs += images \
- ../../../examples/qt3d/shadow-map-qml/doc/images
-
-Cpp.ignoretokens += QT3DCORE_PRIVATE_EXPORT \
- QT3DINPUTSHARED_EXPORT \
- QT3DCORESHARED_EXPORT
-
-Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
-
-navigation.landingpage = "Qt3D Module"
-navigation.cppclassespage = "Qt3D Core C++ Classes"
-navigation.qmltypespage = "Qt3D Core QML Types"
diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3d-index.qdoc
index 9e01e25ff..03f3217d3 100644
--- a/src/core/doc/src/qt3dcore-index.qdoc
+++ b/src/core/doc/src/qt3d-index.qdoc
@@ -37,7 +37,7 @@
/*!
\page qt3d-index.html
- \title Qt3D Module
+ \title Qt 3D
\e Qt3D provides functionality for near-realtime simulation systems
with support for 2D and 3D rendering in both Qt C++ and Qt Quick
@@ -55,11 +55,12 @@
\section1 Getting Started
- For a C++ application that performs 2D or 3D rendering and also handles user
- input, add the following line to your \l qmake \c .pro file:
+ For a C++ application that performs 2D or 3D rendering, collision
+ detection, and also handle user input, add the following line to its
+ \l qmake \c .pro file:
\badcode
- QT += 3dcore 3drenderer 3dinput
+ QT += 3dcore 3drenderer 3dinput 3dcollision 3dlogic
\endcode
To include the definitions of the modules' classes, use the following
@@ -69,12 +70,14 @@
#include <Qt3DCore>
#include <Qt3DRenderer>
#include <Qt3DInput>
+ #include <Qt3DCollision>
+ #include <Qt3DLogic>
\endcode
A Qt Quick application requires also additional dependencies:
\badcode
- QT += 3dcore 3drenderer 3dinput qml quick 3dquick
+ QT += 3dcore 3drenderer 3dinput 3dcollision qml quick 3dquick
\endcode
\section1 Overview
@@ -86,7 +89,8 @@
\section1 Reference
\list
\li \l {Qt3D Overview}
- \li \l [CPP] {Qt3D}{Qt3D Namespace}
+ \li \l {Qt 3D C++ Classes}
+ \li \l {Qt 3D QML Types}
\li \l {Qt3D Examples}
\endlist
diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3d-module.qdoc
index e04c61737..e20c8b117 100644
--- a/src/core/doc/src/qt3dcore-module.qdoc
+++ b/src/core/doc/src/qt3d-module.qdoc
@@ -36,15 +36,44 @@
/*!
\module Qt3DCore
- \title Qt3D Core C++ Classes
- \brief The Qt3D Core module contains functionality to support near-realtime simulation systems.
+ \title Qt 3D Core C++ Classes
+ \brief The Qt 3D module contains functionality to support near-realtime simulation systems.
\ingroup modules
\ingroup qt3d-modules
\qtvariable 3dcore
- The Qt3D Core module provides the foundations and core types used for near-realtime
- simulations built on the Qt3D framework.
+ The Qt 3D module provides the foundations and core types used for near-realtime
+ simulations built on the Qt 3D framework.
+*/
+
+/*!
+ \page qt3d-cpp.html
+ \title Qt 3D C++ Classes
+ \brief The Qt 3D module contains functionality to support near-realtime simulation systems.
+
+ The Qt 3D module provides the foundations and core types used for near-realtime
+ simulations built on the Qt 3D framework.
+
+ \section1 Namespaces
+ \annotatedlist qt3d-namespaces
+
+ \section1 Classes
+
+ \section2 Qt 3D Core Module
+ \generatelist {classesbymodule Qt3DCore}
+
+ \section2 Qt 3D Collision Module
+ \generatelist {classesbymodule Qt3DCollision}
+
+ \section2 Qt 3D Input Module
+ \generatelist {classesbymodule Qt3DInput}
+
+ \section2 Qt 3D Logic Module
+ \generatelist {classesbymodule Qt3DLogic}
+
+ \section2 Qt 3D Renderer Module
+ \generatelist {classesbymodule Qt3DRenderer}
*/
/*!
@@ -52,18 +81,18 @@
\inmodule Qt3DCore
\ingroup qt3d-namespaces
- \brief Contains classes and types that are the foundation of the Qt3D simulation
- framework, as well as classes that provide the ability to render using the Qt3D
- framework.
+ \brief Contains classes that are the foundation for Qt 3D simulation
+ framework, as well as classes that provide the ability to render using the
+ Qt 3D framework.
*/
/*!
\qmlmodule Qt3D 2.0
- \title Qt3D Core QML Types
+ \title Qt 3D QML Types
\ingroup qmlmodules
\ingroup qt3d-qmlmodules
- \brief Provides core Qt3D QML types.
+ \brief Provides core Qt 3D QML types.
To import and use the module's QML types, use the following statement:
@@ -71,5 +100,31 @@
import Qt3D 2.0
\endcode
+ For collision detection, renderer, and input-related QML types, use the
+ following import statements:
+
+ \badcode
+ import Qt3D.Collision 2.0
+ import Qt3D.Renderer 2.0
+ import Qt3D.Input 2.0
+ import Qt3D.Logic 2.0
+ \endcode
+
\section1 QML Types
+
+ \section2 Qt 3D Core Module
+ \generatelist {qmltypesbymodule Qt3D}
+
+ \section2 Qt 3D Collision Module
+ \generatelist {qmltypesbymodule Qt3D.Collision}
+
+ \section2 Qt 3D Input Module
+ \generatelist {qmltypesbymodule Qt3D.Input}
+
+ \section2 Qt 3D Logic Module
+ \generatelist {qmltypesbymodule Qt3D.Logic}
+
+ \section2 Qt 3D Renderer Module
+ \generatelist {qmltypesbymodule Qt3D.Renderer}
+ \noautolist
*/