From eca4f57c854874ec6e4f616e663b43675d76cff4 Mon Sep 17 00:00:00 2001 From: Miikka Heikkinen Date: Thu, 3 Oct 2013 10:41:45 +0300 Subject: Improve documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit +QML types now in their own group +Overview improved, though some linked pages are still just stubs +Some missing documentation added +Some needed tags added to qml type documentations +Removed license page +Fixed lisence footer Change-Id: Ic5e3d922cd5caf9f23294aea6f0e5d2ac493ae63 Reviewed-by: Tomi Korpipää --- .../doc/src/qtdatavisualization-index.qdoc | 38 ++++++++++++++++++---- 1 file changed, 32 insertions(+), 6 deletions(-) (limited to 'src/datavisualization/doc/src/qtdatavisualization-index.qdoc') diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index 843df153..2a09dc68 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -22,28 +22,54 @@ \brief QtDataVisualization module provides functionality for 3D visualization. Qt Data Visualization module provides a way to visualize data in 3D. - It uses OpneGL for the data rendering. + + \section1 Features + + \list + \li Multiple data visualization options: 3D Bars, 3D Scatter, and 3D Surface + \li 2D slice views of the 3D data + \li Interactive data: Rotate, zoom, and highlight data using mouse or touch + \li Uses OpenGL for rendering the data + \li QML2 support + \li Customizable axes for data - control viewable data window with axis ranges + \li Customizable input handling (upcoming feature - not supported in technology preview) + \li Customizable scene handling - full control of cameras and lights (upcoming feature - + not supported in technology preview) + \li Customizable themes (upcoming feature - not supported in technology preview) + \endlist \section1 Getting Started - Qt Data Visualization provides classes for rendering 3D data. To include - the definitions of the module's classes, use the following directive: + To import Qt Data Visualization QML types, add the following import statement to your \c .qml + file: + + \snippet doc_src_qmldatavisualization.cpp 0 + + If you intend to use Qt Data Visualization C++ classes in your application, use the + following directive: \snippet doc_src_qtdatavisualization.cpp 0 - To link against the module, add this line to your qmake \c - .pro file: + \note If you are using a few classes from this module, we recommend including those specific + classes only instead of the whole module. + + To link against Qt Data Visualization module, add this line to your \c qmake project file: \snippet doc_src_qtdatavisualization.pro 0 + See \l{Qt Data Visualization Getting Started}{Getting started} page for further information + how to use Qt Data Visualization in your application. + \section1 Articles \list - \li \l{Qt Data Visualization License Information}{License Information} + \li \l{Qt Data Visualization Data Handling}{Data input} + \li \l{Qt Data Visualization Interacting with Data}{Interacting with visualized data} \endlist \section1 References \list \li \l{Qt Data Visualization C++ Classes} + \li \l{Qt Data Visualization QML Types} \endlist Qt Data Visualization comes with the following examples: -- cgit v1.2.3