summaryrefslogtreecommitdiffstats
path: root/src/core/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-03-17 10:20:16 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2015-03-17 10:44:00 +0000
commit5d816e2a5de1ba69e51167f6d5ec555d4a08b184 (patch)
tree3b373af5ae4fbaecba7eff2784788cccee5c3a6c /src/core/doc
parent8d655cd2490e04727a74688544f5b152b3993fba (diff)
Doc: Add Qt3D landing page
Add a top-level landing (index) page for Qt3D that links to information about the Qt3D modules, overviews, reference pages and examples. Add the Core and Render modules into a 'qt3d-modules' group so they will be listed on the index page. Change-Id: I18f0ec82a676f24e89c5eb068463482a6bd9e59d Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/core/doc')
-rw-r--r--src/core/doc/src/qt3d-index.qdoc75
-rw-r--r--src/core/doc/src/qt3dcore-index.qdoc2
2 files changed, 76 insertions, 1 deletions
diff --git a/src/core/doc/src/qt3d-index.qdoc b/src/core/doc/src/qt3d-index.qdoc
new file mode 100644
index 000000000..81da5d0c2
--- /dev/null
+++ b/src/core/doc/src/qt3d-index.qdoc
@@ -0,0 +1,75 @@
+/****************************************************************************
+**
+** 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 b17aa5474..184068337 100644
--- a/src/core/doc/src/qt3dcore-index.qdoc
+++ b/src/core/doc/src/qt3dcore-index.qdoc
@@ -38,7 +38,7 @@
\title Qt3D Core
\page qt3dcore-index.html
\brief The Qt3D Core module contains functionality to support near-realtime simulation systems.
-
+ \ingroup qt3d-modules
\section1 Getting Started