summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization.qdoc
diff options
context:
space:
mode:
authorTomi Korpipää <tomi.korpipaa@digia.com>2013-10-15 10:55:37 +0300
committerTomi Korpipää <tomi.korpipaa@digia.com>2013-10-15 11:01:27 +0300
commit0109b085710bfabc81faf43118ad5654cbd96081 (patch)
treef50fca0c6b152a107eef81c9998a66dd9b87f054 /src/datavisualization/doc/src/qtdatavisualization.qdoc
parentad8e369486b8bc718ef055e5a2574343e1e3aeb9 (diff)
Docs and images updates
Change-Id: I835425b441e3a82fadb05da5159c3d5ec02a2898 Reviewed-by: Titta Heikkala <titta.heikkala@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src/qtdatavisualization.qdoc')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization.qdoc80
1 files changed, 72 insertions, 8 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc
index 45087e9d..191c7ba8 100644
--- a/src/datavisualization/doc/src/qtdatavisualization.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc
@@ -21,7 +21,9 @@
\title Qt Data Visualization C++ Classes
\ingroup modules
- \brief The QtDataVisualization module provides functionality for 3D visualization.
+ \brief C++ classes for the Qt Data Visualization API.
+
+ Qt Data Visualization functionality can be accessed via these C++ classes.
*/
/*!
@@ -36,19 +38,81 @@
*/
/*!
+ \group datavisualization_examples
+ \title Qt Data Visualization Examples
+
+ \brief Examples for the Qt Data Visualization.
+
+ For some code examples, see one of the Qt Data Visualization examples:
+
+ \section1 Examples
+
+ \annotatedlist qtdatavisualization_examples
+*/
+
+/*!
\page qtdatavisualization_getting_started.html
\title Qt Data Visualization Getting Started
\section1 Building Qt Data Visualization
To build Qt Data Visualization module, set up a command prompt with an environment for
- building Qt applications, navigate to the directory containing \c qtdatavisualization.pro,
- and give the following commands:
-
- \snippet doc_src_qtdatavisualization.cpp 6
-
- \note The \c make tool name may vary depending on your target platform.
- E.g. make/nmake/mingw32-make/...
+ building Qt applications, navigate to the directory containing \c qtdatavisualization.pro, and
+ configure the project with qmake:
+ \code
+ qmake
+ \endcode
+
+ After running qmake, build the project with make:
+ \table
+ \header
+ \li OS \li Make command
+ \row
+ \li Linux \li make
+ \row
+ \li Windows (MinGw) \li mingw32-make
+ \row
+ \li Windows (MSVC) \li nmake
+ \row
+ \li OSX \li make
+ \endtable
+
+ The above generates the default makefiles for your configuration, which is typically
+ the release build if you are using precompiled binary Qt distribution. To build both debug
+ and release, or one specifically, use one of the following qmake lines instead.
+
+ For debug builds:
+ \code
+ qmake CONFIG+=debug; make
+ \endcode
+ or
+ \code
+ qmake CONFIG+=debug_and_release; make debug
+ \endcode
+
+ For release builds:
+ \code
+ qmake CONFIG+=release ; make
+ \endcode
+ or
+ \code
+ qmake CONFIG+=debug_and_release; make release
+ \endcode
+
+ For both builds
+ \code
+ qmake CONFIG+="debug_and_release build_all"; make
+ \endcode
+
+ If you want to install the module to your Qt directory use:
+ \code
+ make install
+ \endcode
+
+ If you want to uninstall the module
+ \code
+ make uninstall
+ \endcode
To build a statically linked version of the Qt Data Visualization module, give the following
commands: