Doc: add doc for Qt3DExtras module

Change-Id: I4850cd747416b37fe88675099d9b405c2d9e173e
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

3 files changed, 164 insertions, 1 deletions

diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index 3abc22d11..fce9a02f3 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
@@ -61,7 +61,7 @@
     \l qmake \c .pro file:
 
     \badcode
-    QT += 3dcore 3drender 3dinput 3dlogic
+    QT += 3dcore 3drender 3dinput 3dlogic 3dextras
     \endcode
 
     To include the definitions of the modules' classes, use the following
@@ -72,6 +72,7 @@
     #include <Qt3DRender>
     #include <Qt3DInput>
     #include <Qt3DLogic>
+    #include <Qt3DExtras>
     \endcode
 
     A Qt Quick application requires also additional dependencies:
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index f6dc6934d..c82c528f1 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -74,6 +74,9 @@
 
     \section2 Qt 3D Render Module
     \generatelist {classesbymodule Qt3DRender}
+
+    \section2 Qt 3D Extras Module
+    \generatelist {classesbymodule Qt3DExtras}
 */
 
 /*!
@@ -107,6 +110,7 @@
    import Qt3D.Render 2.0
    import Qt3D.Input 2.0
    import Qt3D.Logic 2.0
+   import Qt3D.Extras 2.0
    \endcode
 
    \section1 QML Types
@@ -123,4 +127,8 @@
    \section2 Qt 3D Render Module
    \generatelist {qmltypesbymodule Qt3D.Render}
    \noautolist
+
+   \section2 Qt 3D Extras Module
+   \generatelist {qmltypesbymodule Qt3D.Extras}
+   \noautolist
 */
diff --git a/src/doc/src/qt3dextras-module.qdoc b/src/doc/src/qt3dextras-module.qdoc
new file mode 100644
index 000000000..087018139
--- /dev/null
+++ b/src/doc/src/qt3dextras-module.qdoc
@@ -0,0 +1,154 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \module Qt3DExtras
+    \title Qt 3D Extras C++ Classes
+
+    \brief The Qt 3D Extras modules provides a set of prebuilt elements to help
+    you get started with Qt 3D.
+
+    This module is still in tech preview. This means it is unstable, likely to
+    change and provided as a convenience only.
+
+    \ingroup modules
+    \ingroup qt3d-modules
+    \qtvariable 3dextras
+
+    \code
+       #include <Qt3DExtras>
+    \endcode
+
+    To link against the corresponding C++ library, add the following to your qmake project file:
+
+    \badcode
+       QT += 3dextras
+    \endcode
+
+    Classes, types, and functions are declared under the \l [Qt3DExtras]{Qt3DExtras} namespace.
+
+    \section1 Overview
+
+    \section2 Materials
+
+    \list
+    \li Qt3DExtras::QDiffuseMapMaterial
+    \li Qt3DExtras::QDiffuseSpecularMapMaterial
+    \li Qt3DExtras::QGoochMaterial
+    \li Qt3DExtras::QNormalDiffuseMapMaterial
+    \li Qt3DExtras::QNormalDiffuseMapAlphaMaterial
+    \li Qt3DExtras::QNormalDiffuseSpecularMapMaterial
+    \li Qt3DExtras::QPerVertexColorMaterial
+    \li Qt3DExtras::QPhongMaterial
+    \li Qt3DExtras::QPhongAlphaMaterial
+    \endlist
+
+    \section2 Meshes and Geometries
+
+    \list
+    \li Qt3DExtras::QConeGeometry
+    \li Qt3DExtras::QConeMesh
+    \li Qt3DExtras::QCuboidGeometry
+    \li Qt3DExtras::QCuboidMesh
+    \li Qt3DExtras::QCylinderGeometry
+    \li Qt3DExtras::QCylinderMesh
+    \li Qt3DExtras::QPlaneGeometry
+    \li Qt3DExtras::QPlaneMesh
+    \li Qt3DExtras::QSphereGeometry
+    \li Qt3DExtras::QSphereMesh
+    \li Qt3DExtras::QTorusGeometry
+    \li Qt3DExtras::QTorusMesh
+    \endlist
+
+    \section2 Camera Controllers
+
+    \list
+    \li Qt3DExtras::QFirstPersonCameraController
+    \li Qt3DExtras::QOrbitCameraController
+    \endlist
+
+    \section2 Entities
+
+    \list
+    \li Qt3DExtras::QSkyboxEntity
+    \endlist
+
+    \section2 FrameGraphs
+
+    \list
+    \li Qt3DExtras::QForwardRenderer
+    \endlist
+
+    \section2 Window
+
+    \list
+    \li Qt3DExtras::Qt3DWindow
+    \endlist
+
+    \note The Quick3DExtras module also specifies a Qt3DExtras::Quick::Qt3DQuickWindow.
+
+    \section1 Reference
+    \list
+    \li \l {Qt 3D Extras C++ Classes}
+    \li \l {Qt 3D Examples}
+    \endlist
+ */
+
+/*!
+    \namespace Qt3DExtras
+    \inmodule Qt3DExtras
+    \ingroup qt3d-namespaces
+
+    \brief Contains classes from the Qt3DExtras module.
+*/
+
+/*!
+   \qmlmodule Qt3D.Extras 2.0
+   \title Qt 3D Extras QML Types
+   \ingroup qmlmodules
+   \ingroup qt3d-qmlmodules
+
+   \brief Provides Qt 3D QML types for the extras module.
+
+   To import and use the module's QML types, use the following statement:
+
+   \badcode
+   import Qt3D.Extras 2.0
+   \endcode
+*/