summaryrefslogtreecommitdiffstats
path: root/src/doc/src
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2018-04-23 14:09:21 +0200
committerPaul Wicking <paul.wicking@qt.io>2018-04-26 12:08:43 +0000
commit988928b9d37dfae08b5a98cd139eaaa14e72c02c (patch)
tree13e7de1378be04b0ed0c4b95f75c595f5731b69d /src/doc/src
parent898c11d13a1af0c70fc8d5902bf3da210d6c2faf (diff)
Doc: Add basic documentation for Scene3D QML module
Adds Scene3D as QML module. Provides preliminary documentation for Scene3D QML type. Task-number: QTBUG-61651 Task-number: QTBUG-54816 Change-Id: I2811bb2165ca0adde574ddde70fa7185b3c03083 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/doc/src')
-rw-r--r--src/doc/src/qt3d-module.qdoc4
-rw-r--r--src/doc/src/qt3dscene3d-module.qdoc54
2 files changed, 58 insertions, 0 deletions
diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc
index cb08a60c0..2e6eff6b2 100644
--- a/src/doc/src/qt3d-module.qdoc
+++ b/src/doc/src/qt3d-module.qdoc
@@ -96,6 +96,7 @@
import Qt3D.Extras 2.0
import Qt3D.Animation 2.9
import Qt3D.Scene2D 2.9
+ import Qt3D.Scene3D 2.9
\endcode
\section1 QML Types
@@ -124,4 +125,7 @@
\section2 Qt 3D Scene2D Module
\generatelist {qmltypesbymodule Qt3D.Scene2D}
\noautolist
+
+ \section2 Qt 3D Scene3D Module
+ \generatelist {qmltypesbymodule Qt3D.Scene3D}
*/
diff --git a/src/doc/src/qt3dscene3d-module.qdoc b/src/doc/src/qt3dscene3d-module.qdoc
new file mode 100644
index 000000000..08cf2d371
--- /dev/null
+++ b/src/doc/src/qt3dscene3d-module.qdoc
@@ -0,0 +1,54 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 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$
+**
+****************************************************************************/
+
+/*!
+ \qmlmodule Qt3D.Scene3D 2.0
+ \preliminary
+ \title Qt 3D Scene3D QML Types
+ \ingroup qmlmodules
+ \ingroup qt3d-qmlmodules-preliminary
+
+ \brief Provides Qt 3D QML types for the Scene3D module.
+
+ To import and use the module's QML types, use the following statement:
+
+ \badcode
+ import Qt3D.Scene3D 2.0
+ \endcode
+*/