summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSean Harmer <sean.harmer@kdab.com>2015-06-11 10:05:48 +0100
committerJani Heikkinen <jani.heikkinen@theqtcompany.com>2015-06-11 16:12:48 +0000
commit137bd818e743dc97fdceb9b8870adf370c2fd289 (patch)
tree951b836e7866ef8a6f72eb62b4af0400ab458a59
parent57f11fe309969665ddebafa3b770263d2d82fa93 (diff)
Move Qt3D generic index to Qt3DCore index
There is no Qt3D library, there is only Qt3DCore, Qt3DRenderer and Qt3DInput so we put the global stuff into the Qt3DCore docs. Change-Id: I31077581ba159d828d0f64968a83920308676007 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
-rw-r--r--src/core/doc/src/qt3d-index.qdoc75
-rw-r--r--src/core/doc/src/qt3dcore-index.qdoc53
2 files changed, 38 insertions, 90 deletions
diff --git a/src/core/doc/src/qt3d-index.qdoc b/src/core/doc/src/qt3d-index.qdoc
deleted file mode 100644
index 81da5d0c2..000000000
--- a/src/core/doc/src/qt3d-index.qdoc
+++ /dev/null
@@ -1,75 +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$
-**
-****************************************************************************/
-
-/*!
- \page qt3d-index.html
- \title Qt3D Module
-
- \e Qt3D provides functionality for near-realtime simulation systems
- with support for 2D and 3D rendering in both Qt C++ and Qt Quick
- applications.
-
- The functionality in Qt3D is divided into the following modules:
-
- \annotatedlist qt3d-modules
-
- Classes, types and functions are declared under the \l Qt3D namespace.
-
- \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:
-
- \badcode
- QT += 3dcore 3drenderer 3dinput
- \endcode
-
- To include the definitions of the modules' classes, use the following
- directives:
-
- \badcode
- #include <Qt3DCore>
- #include <Qt3DRenderer>
- #include <Qt3DInput>
- \endcode
-
- A Qt Quick application requires also additional dependencies:
-
- \badcode
- QT += 3dcore 3drenderer 3dinput qml quick 3dquick
- \endcode
-
- \section1 Overview
-
- \section1 Reference
- \list
- \li \l {Qt3D}{Qt3D namespace}
- \li \l {Qt3D Core C++ Classes}
- \li \l {Qt3D Render C++ Classes}
- \li \l {Qt3D Examples}
- \endlist
-*/
diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3dcore-index.qdoc
index b2908264b..8401e13a6 100644
--- a/src/core/doc/src/qt3dcore-index.qdoc
+++ b/src/core/doc/src/qt3dcore-index.qdoc
@@ -1,5 +1,6 @@
/****************************************************************************
**
+** Copyright (C) 2015 The Qt Company Ltd.
** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
** Contact: http://www.qt-project.org/legal
**
@@ -35,31 +36,53 @@
****************************************************************************/
/*!
- \title Qt3D Core
- \page qt3dcore-index.html
- \brief The Qt3D Core module contains functionality to support near-realtime simulation systems.
- \ingroup qt3d-modules
+ \page qt3dcore-index.html
+ \title Qt3D Module
+
+ \e Qt3D provides functionality for near-realtime simulation systems
+ with support for 2D and 3D rendering in both Qt C++ and Qt Quick
+ applications.
+
+ The functionality in Qt3D is divided into the following modules:
+
+ \annotatedlist qt3d-modules
+
+ Classes, types and functions are declared under the \l Qt3D namespace.
\section1 Getting Started
- To use Qt3D classes, add this directive into the C++ files:
+ 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:
- \code
- #include <Qt3DCore>
+ \badcode
+ QT += 3dcore 3drenderer 3dinput
\endcode
- To link against the corresponding C++ libraries, add the following to your qmake project file:
+ To include the definitions of the modules' classes, use the following
+ directives:
- \code
- QT += 3dcore
+ \badcode
+ #include <Qt3DCore>
+ #include <Qt3DRenderer>
+ #include <Qt3DInput>
\endcode
- \section1 Reference
+ A Qt Quick application requires also additional dependencies:
+ \badcode
+ QT += 3dcore 3drenderer 3dinput qml quick 3dquick
+ \endcode
+
+ \section1 Overview
+
+ The high level design and motivation for Qt3D is described in the
+ \l {Qt3D Overview}.
+
+ \section1 Reference
\list
- \li \l {Qt3D Core C++ Classes}
- \li \l {Qt3D Core QML Types}
- \li \l {Qt3D Examples}
+ \li \l {Qt3D}{Qt3D namespace}
+ \li \l {Qt3D Core C++ Classes}
+ \li \l {Qt3D Render C++ Classes}
+ \li \l {Qt3D Examples}
\endlist
-
*/