From c6be71ca61ba2f60c49f28f74d8d12abbb678324 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A4=C3=A4tt=C3=A4=20Antti?= <antti.maatta@qt.io>
Date: Wed, 12 Apr 2017 12:34:10 +0300
Subject: 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>
---
 src/doc/src/qt3d-module.qdoc        |  7 +++
 src/doc/src/qt3dscene2d-module.qdoc | 94 +++++++++++++++++++++++++++++++++++++
 2 files changed, 101 insertions(+)
 create mode 100644 src/doc/src/qt3dscene2d-module.qdoc

(limited to 'src/doc/src')

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
+*/
-- 
cgit v1.2.3