summaryrefslogtreecommitdiffstats
path: root/src/render/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'src/render/doc/src')
-rw-r--r--src/render/doc/src/qt3d-examples.qdoc41
-rw-r--r--src/render/doc/src/qt3drenderer-index.qdoc77
-rw-r--r--src/render/doc/src/qt3drenderer-module.qdoc14
3 files changed, 55 insertions, 77 deletions
diff --git a/src/render/doc/src/qt3d-examples.qdoc b/src/render/doc/src/qt3d-examples.qdoc
new file mode 100644
index 000000000..4ba413e50
--- /dev/null
+++ b/src/render/doc/src/qt3d-examples.qdoc
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** 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-examples.html
+ \ingroup all-examples
+ \title Qt3D Examples
+ \brief Examples that demonstrate 2D and 3D rendering using Qt3D.
+
+ The following examples demonstrate 2D and 3D rendering using Qt3D.
+
+ \section1 QML Examples
+ \annotatedlist qt3d-examples-qml
+
+ \section1 C++ Examples
+ \annotatedlist qt3d-examples-cpp
+*/
diff --git a/src/render/doc/src/qt3drenderer-index.qdoc b/src/render/doc/src/qt3drenderer-index.qdoc
deleted file mode 100644
index 0aa93fc9c..000000000
--- a/src/render/doc/src/qt3drenderer-index.qdoc
+++ /dev/null
@@ -1,77 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
-** Contact: http://www.qt-project.org/legal
-**
-** This file is part of the Qt3D module of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:LGPL3$
-** 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 Lesser General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 3 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPLv3 included in the
-** packaging of this file. Please review the following information to
-** ensure the GNU Lesser General Public License version 3 requirements
-** will be met: https://www.gnu.org/licenses/lgpl.html.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 2.0 or later as published by the Free
-** Software Foundation and appearing in the file LICENSE.GPL included in
-** the packaging of this file. Please review the following information to
-** ensure the GNU General Public License version 2.0 requirements will be
-** met: http://www.gnu.org/licenses/gpl-2.0.html.
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page qt3drender-index.html
- \title Qt3D Renderer
- \ingroup qt3d-modules
- \brief The Qt3D Renderer module contains functionality to support 2D and 3D rendering using Qt3D.
-
- \section1 Getting Started
-
- To use Qt3D classes, add this directive into the C++ files:
-
- \code
- #include <Qt3DRenderer>
- \endcode
-
- To link against the corresponding C++ libraries, add the following to your qmake project file:
-
- \code
- QT += 3drenderer
- \endcode
-
- \section1 Reference
- \list
- \li \l {Qt3D Renderer C++ Classes}
- \li \l {Qt3D Examples}
- \endlist
-*/
-
-/*!
- \page qt3d-examples.html
- \ingroup all-examples
- \title Qt3D Examples
- \brief Examples that demostrate 2D and 3D rendering using Qt3D.
-
- The following examples demonstrate 2D and 3D rendering using Qt3D.
-
- \section1 QML Examples
- \annotatedlist qt3d-examples-qml
-
- \section1 C++ Examples
- \annotatedlist qt3d-examples-cpp
-*/
diff --git a/src/render/doc/src/qt3drenderer-module.qdoc b/src/render/doc/src/qt3drenderer-module.qdoc
index 25b551ce4..d927070c3 100644
--- a/src/render/doc/src/qt3drenderer-module.qdoc
+++ b/src/render/doc/src/qt3drenderer-module.qdoc
@@ -40,11 +40,24 @@
\brief The Qt3D Renderer module contains functionality to support 2D and 3D rendering using Qt3D.
\ingroup modules
+ \ingroup qt3d-modules
\qtvariable 3drenderer
The Qt3D Renderer module provides an aspect, components, and other supporting types necessary
to implement 2D and 3D rendering as part of the Qt3D framework.
+ To use classes from this module, add this directive into the C++ files:
+
+ \code
+ #include <Qt3DRenderer>
+ \endcode
+
+ To link against the corresponding C++ library, add the following to your qmake project file:
+
+ \badcode
+ QT += 3drenderer
+ \endcode
+
Classes, types, and functions are declared under the \l [Qt3DCore]{Qt3D} namespace.
*/
@@ -52,6 +65,7 @@
\qmlmodule Qt3D.Renderer 2.0
\title Qt3D Renderer QML Types
\ingroup qmlmodules
+ \ingroup qt3d-qmlmodules
\brief Provides Qt3D QML types for rendering.