diff options
author | Kai Koehne <kai.koehne@qt.io> | 2018-01-16 17:02:03 +0100 |
---|---|---|
committer | Kai Koehne <kai.koehne@qt.io> | 2018-03-12 08:45:50 +0000 |
commit | d6f62cc4ca72ee97711b47425fbcda988a8de83e (patch) | |
tree | 10dfb75abd69e2b08b7d44cfc964b0eb02870480 | |
parent | ec19b4657aa6aef60c21d6bd012dfb74c3e0a0b4 (diff) |
Document state of the Qt 3D modules
Do make it explicit which ones are still in development
also in the landing page, and add \preliminary and \since
tags (for released and TP modules, respectively).
Note that the \preliminary, \since tags currently do
not work for \qmlmodule, which hopefully gets fixed at
one point: QTBUG-65963.
Change-Id: I6648311c38f331286be37eefa60794984cd239b7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r-- | src/animation/doc/src/qt3danimation-module.qdoc | 11 | ||||
-rw-r--r-- | src/core/doc/src/qt3dcore-module.qdoc | 2 | ||||
-rw-r--r-- | src/doc/src/qt3d-index.qdoc | 10 | ||||
-rw-r--r-- | src/doc/src/qt3d-module.qdoc | 2 | ||||
-rw-r--r-- | src/extras/doc/src/qt3dextras-module.qdoc | 11 | ||||
-rw-r--r-- | src/input/doc/src/qt3dinput-module.qdoc | 3 | ||||
-rw-r--r-- | src/logic/doc/src/qt3dlogic-module.qdoc | 4 | ||||
-rw-r--r-- | src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc | 10 | ||||
-rw-r--r-- | src/render/doc/src/qt3drender-module.qdoc | 3 |
9 files changed, 44 insertions, 12 deletions
diff --git a/src/animation/doc/src/qt3danimation-module.qdoc b/src/animation/doc/src/qt3danimation-module.qdoc index 3aaf819db..918c401f9 100644 --- a/src/animation/doc/src/qt3danimation-module.qdoc +++ b/src/animation/doc/src/qt3danimation-module.qdoc @@ -29,16 +29,17 @@ /*! \module Qt3DAnimation \title Qt 3D Animation C++ Classes + \preliminary \keyword Qt 3D Animation \brief The Qt 3D Animation module 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. + This module is still in development but is available as a technology preview. + This means it is unstable, likely to change and provided as a convenience only. \ingroup modules - \ingroup qt3d-modules + \ingroup qt3d-modules-preliminary \qtvariable 3danimation \code @@ -216,8 +217,10 @@ /*! \qmlmodule Qt3D.Animation 2.9 \title Qt 3D Qt3DAnimation QML Types + \preliminary + \ingroup qmlmodules - \ingroup qt3d-qmlmodules + \ingroup qt3d-qmlmodules-preliminary \brief Provides Qt 3D QML types for the animation module. diff --git a/src/core/doc/src/qt3dcore-module.qdoc b/src/core/doc/src/qt3dcore-module.qdoc index 20e8f6e02..d21c1d9ec 100644 --- a/src/core/doc/src/qt3dcore-module.qdoc +++ b/src/core/doc/src/qt3dcore-module.qdoc @@ -42,6 +42,7 @@ \title Qt 3D Core C++ Classes \keyword Qt 3D Core \brief The Qt 3D module contains functionality to support near-realtime simulation systems. + \since 5.7 \ingroup modules \ingroup qt3d-modules @@ -66,6 +67,7 @@ \title Qt 3D Core QML Types \ingroup qmlmodules \ingroup qt3d-qmlmodules + \since 5.7 \brief Provides core Qt 3D QML types. diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 2031fcfdc..0e889e652 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -50,10 +50,20 @@ \annotatedlist qt3d-modules + The following C++ modules are in still development but are available + as technology previews: + + \annotatedlist qt3d-modules-preliminary + For Qt Quick applications, Qt 3D provides the following QML modules: \annotatedlist qt3d-qmlmodules + The following QML modules are in still development but are available + as technology previews: + + \annotatedlist qt3d-qmlmodules-preliminary + \section1 Getting Started For a C++ application that performs 2D or 3D rendering, collision diff --git a/src/doc/src/qt3d-module.qdoc b/src/doc/src/qt3d-module.qdoc index c7d589c2a..cb08a60c0 100644 --- a/src/doc/src/qt3d-module.qdoc +++ b/src/doc/src/qt3d-module.qdoc @@ -41,6 +41,7 @@ \page qt3d-cpp.html \title Qt 3D C++ Classes \brief The Qt 3D module contains functionality to support near-realtime simulation systems. + \since 5.7 The Qt 3D module provides the foundations and core types used for near-realtime simulations built on the Qt 3D framework. @@ -76,6 +77,7 @@ \page qt3d-qml.html \title Qt 3D QML Types \brief QML Types for the Qt 3D module. + \since 5.7 The Qt 3D core QML types are imported with diff --git a/src/extras/doc/src/qt3dextras-module.qdoc b/src/extras/doc/src/qt3dextras-module.qdoc index a90d29a51..98cfdf17a 100644 --- a/src/extras/doc/src/qt3dextras-module.qdoc +++ b/src/extras/doc/src/qt3dextras-module.qdoc @@ -41,15 +41,16 @@ \module Qt3DExtras \title Qt 3D Extras C++ Classes \keyword Qt 3D Extras + \preliminary \brief The Qt 3D Extras module 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. + This module is still in development but is available as a technology preview. + This means it is unstable, likely to change and provided as a convenience only. \ingroup modules - \ingroup qt3d-modules + \ingroup qt3d-modules-preliminary \qtvariable 3dextras \code @@ -116,8 +117,10 @@ /*! \qmlmodule Qt3D.Extras 2.0 \title Qt 3D Extras QML Types + \preliminary + \ingroup qmlmodules - \ingroup qt3d-qmlmodules + \ingroup qt3d-qmlmodules-preliminary \brief Provides Qt 3D QML types for the extras module. diff --git a/src/input/doc/src/qt3dinput-module.qdoc b/src/input/doc/src/qt3dinput-module.qdoc index 2d9fc478b..7739d596d 100644 --- a/src/input/doc/src/qt3dinput-module.qdoc +++ b/src/input/doc/src/qt3dinput-module.qdoc @@ -31,6 +31,7 @@ \keyword Qt 3D Input \brief The Qt 3D Input module provides classes for handling user input in applications using Qt3D. + \since 5.7 \ingroup modules \ingroup qt3d-modules @@ -60,6 +61,8 @@ /*! \qmlmodule Qt3D.Input 2.0 \title Qt 3D Input QML Types + \since 5.7 + \ingroup qmlmodules \ingroup qt3d-qmlmodules diff --git a/src/logic/doc/src/qt3dlogic-module.qdoc b/src/logic/doc/src/qt3dlogic-module.qdoc index db21e050f..8994b8bcd 100644 --- a/src/logic/doc/src/qt3dlogic-module.qdoc +++ b/src/logic/doc/src/qt3dlogic-module.qdoc @@ -29,6 +29,8 @@ \module Qt3DLogic \title Qt 3D Logic C++ Classes \keyword Qt 3D Logic + \since 5.7 + \brief The Qt 3D Logic module enables synchronizing frames with the Qt 3D backend. \ingroup modules @@ -60,6 +62,8 @@ /*! \qmlmodule Qt3D.Logic 2.0 \title Qt 3D Logic QML Types + \since 5.7 + \ingroup qmlmodules \ingroup qt3d-qmlmodules diff --git a/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc b/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc index 8a35c11cb..8809f469a 100644 --- a/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc +++ b/src/quick3d/quick3dscene2d/doc/src/qt3dscene2d-module.qdoc @@ -41,15 +41,16 @@ \module Qt3DScene2D \title Qt 3D Scene2D C++ Classes \keyword Qt 3D Scene2D + \preliminary \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. + This module is still in development but is available as a technology preview. + This means it is unstable, likely to change and provided as a convenience only. \ingroup modules - \ingroup qt3d-modules + \ingroup qt3d-modules-preliminary \qtvariable 3dquickscene2d \code @@ -81,9 +82,10 @@ /*! \qmlmodule Qt3D.Scene2D 2.9 + \preliminary \title Qt 3D Scene2D QML Types \ingroup qmlmodules - \ingroup qt3d-qmlmodules + \ingroup qt3d-qmlmodules-preliminary \brief Provides Qt 3D QML types for the scene2d module. diff --git a/src/render/doc/src/qt3drender-module.qdoc b/src/render/doc/src/qt3drender-module.qdoc index e1f54310c..3a7a6f6bb 100644 --- a/src/render/doc/src/qt3drender-module.qdoc +++ b/src/render/doc/src/qt3drender-module.qdoc @@ -43,6 +43,7 @@ \keyword Qt 3D Render \brief The Qt 3D Render module contains functionality to support 2D and 3D rendering using Qt 3D. + \since 5.7 \ingroup modules \ingroup qt3d-modules @@ -88,6 +89,8 @@ /*! \qmlmodule Qt3D.Render 2.0 \title Qt 3D Render QML Types + \since 5.7 + \ingroup qmlmodules \ingroup qt3d-qmlmodules |