Add skeleton documentation for scene2d module

Add a skeleton documentation. The scene2d docs still need updating with
proper usage instruction and docs for the final IF.

Task-number: QTBUG-60099
Change-Id: I0a0f329d22b4f694bc663e635533f298da7e0605
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

4 files changed, 114 insertions, 8 deletions

diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf
index 941c9e3f6..8c1508fa4 100644
--- a/src/doc/qt3d.qdocconf
+++ b/src/doc/qt3d.qdocconf
@@ -48,7 +48,8 @@ headerdirs += . \
               ../quick3d/quick3d \
               ../input \
               ../extras \
-              ../animation
+              ../animation \
+              ../quick3d/quick3dscene2d
 
 # Exclude private header files from the documentation build
 excludefiles += "*_p.h"
@@ -61,7 +62,8 @@ sourcedirs += . \
               ../quick3d/quick3d \
               ../input \
               ../extras \
-              ../animation
+              ../animation \
+              ../quick3d/quick3dscene2d
 
 exampledirs += ../../examples/qt3d \
                snippets
@@ -69,7 +71,9 @@ exampledirs += ../../examples/qt3d \
 examples.fileextensions       += "*.fraq *.geom *.vert"
 examples.imageextensions      += "*.png"
 
-#excludedirs +=
+excludedirs += \
+              ../plugins/renderplugins
+
 macro.TODO = " "
 imagedirs   += images \
                ../../examples/qt3d/shadow-map-qml/doc/images \
@@ -86,7 +90,8 @@ Cpp.ignoretokens     += QT3DINPUTSHARED_EXPORT \
                         QT3DRENDERSHARED_PRIVATE_EXPORT \
                         QT3DQUICKSHARED_PRIVATE_EXPORT \
                         QT3DEXTRASSHARED_EXPORT \
-                        QT3DANIMATIONSHARED_EXPORT
+                        QT3DANIMATIONSHARED_EXPORT \
+                        QT3DQUICKSCENE2DSHARED_EXPORT
 
 Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY
 
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index 0c3d14b56..0e26375a9 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -80,6 +80,9 @@
 
     \section2 Qt 3D Animation Module
     \generatelist {classesbymodule Qt3DAnimation}
+
+    \section2 Qt 3D Scene2D Module
+    \generatelist {classesbymodule Qt3DScene2D}
 */
 
 /*!
@@ -139,4 +142,8 @@
    \section2 Qt 3D Animation Module
    \generatelist {qmltypesbymodule Qt3D.Animation}
    \noautolist
+
+   \section2 Qt 3D Scene2D Module
+   \generatelist {qmltypesbymodule Qt3D.Scene2D}
+   \noautolist
 */
diff --git a/src/doc/src/qt3dscene2d-module.qdoc b/src/doc/src/qt3dscene2d-module.qdoc
new file mode 100644
index 000000000..a389a8ed0
--- /dev/null
+++ b/src/doc/src/qt3dscene2d-module.qdoc
@@ -0,0 +1,94 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd and/or its subsidiary(-ies).
+** 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 Qt3DScene2D
+    \title Qt 3D Scene2D C++ Classes
+
+    \brief The Qt 3D Scene2D module provides a way to render Quick2 qml content
+    to a Qt 3D texture.
+
+    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 3dquickscene2d
+
+    \code
+       #include <Qt3DQuickScene2D>
+    \endcode
+
+    To link against the corresponding C++ library, add the following to your qmake project file:
+
+    \badcode
+       QT += 3dquickscene2d
+    \endcode
+
+    Classes, types, and functions are declared under the \l [Qt3DScene2D]{Qt3DScene2D} namespace.
+
+    \section1 Overview
+
+    \section2 Scene2D
+
+    \list
+    \li Qt3DRender::Quick::QScene2D
+    \endlist
+
+    \section1 Reference
+    \list
+    \li \l {Qt 3D Extras C++ Classes}
+    \li \l {Qt 3D Examples}
+    \endlist
+ */
+
+/*!
+   \qmlmodule Qt3D.Scene2D 2.9
+   \title Qt 3D Scene2D QML Types
+   \ingroup qmlmodules
+   \ingroup qt3d-qmlmodules
+
+   \brief Provides Qt 3D QML types for the scene2d module.
+
+   To import and use the module's QML types, use the following statement:
+
+   \badcode
+   import Qt3D.Scene2D 2.9
+   \endcode
+*/
diff --git a/src/quick3d/quick3dscene2d/items/qscene2d.cpp b/src/quick3d/quick3dscene2d/items/qscene2d.cpp
index 8b6c511eb..3470ac9d8 100644
--- a/src/quick3d/quick3dscene2d/items/qscene2d.cpp
+++ b/src/quick3d/quick3dscene2d/items/qscene2d.cpp
@@ -53,8 +53,8 @@ namespace Qt3DRender {
 namespace Quick {
 
 /*!
-    \class Qt3DRender::QScene2D
-    \inmodule Qt3DRender
+    \class Qt3DRender::Quick::QScene2D
+    \inmodule Qt3DScene2D
 
     \brief This class enables rendering qml into a texture, which then can be
     used as a part of 3D scene.
@@ -69,10 +69,10 @@ namespace Quick {
 
 /*!
     \qmltype Scene2D
-    \inqmlmodule Qt3D.Render
+    \inqmlmodule Qt3D.Scene2D
     \since
     \ingroup
-    \instantiates Qt3DRender::QScene2D
+    \instantiates Qt3DRender::Quick::QScene2D
     \brief Scene2D
  */