From d6f62cc4ca72ee97711b47425fbcda988a8de83e Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Tue, 16 Jan 2018 17:02:03 +0100 Subject: 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 --- src/doc/src/qt3d-index.qdoc | 10 ++++++++++ src/doc/src/qt3d-module.qdoc | 2 ++ 2 files changed, 12 insertions(+) (limited to 'src/doc') 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 -- cgit v1.2.3