From 0109b085710bfabc81faf43118ad5654cbd96081 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomi=20Korpip=C3=A4=C3=A4?= Date: Tue, 15 Oct 2013 10:55:37 +0300 Subject: Docs and images updates Change-Id: I835425b441e3a82fadb05da5159c3d5ec02a2898 Reviewed-by: Titta Heikkala --- .../doc/qtdatavisualization.qdocconf | 32 ++++++--- .../doc/src/qtdatavisualization.qdoc | 80 +++++++++++++++++++--- .../global/qtdatavisualizationenums.qdoc | 3 + 3 files changed, 96 insertions(+), 19 deletions(-) (limited to 'src/datavisualization') diff --git a/src/datavisualization/doc/qtdatavisualization.qdocconf b/src/datavisualization/doc/qtdatavisualization.qdocconf index 82a5d8c4..a485d509 100644 --- a/src/datavisualization/doc/qtdatavisualization.qdocconf +++ b/src/datavisualization/doc/qtdatavisualization.qdocconf @@ -15,7 +15,7 @@ sourcedirs += .. depends += qtcore \ qtgui -qhp.projects = qtdatavisualization +qhp.projects = qtdatavisualization qhp.qtdatavisualization.file = qtdatavisualization.qhp qhp.qtdatavisualization.namespace = org.qt-project.qtdatavisualization.0.1.0 @@ -23,15 +23,26 @@ qhp.qtdatavisualization.virtualFolder = qtdatavisualization qhp.qtdatavisualization.indexTitle = Qt Data Visualization qhp.qtdatavisualization.indexRoot = -qhp.qtdatavisualization.filterAttributes = qtdatavisualization 0.1.0 qtrefdoc -qhp.qtdatavisualization.customFilters.Qt.name = QtDataVisualization 0.1.0 -qhp.qtdatavisualization.customFilters.Qt.filterAttributes = qtdatavisualization 0.1.0 -qhp.qtdatavisualization.subprojects = classes -qhp.qtdatavisualization.subprojects.classes.title = C++ Classes -qhp.qtdatavisualization.subprojects.classes.indexTitle = Qt Data Visualization C++ Classes -qhp.qtdatavisualization.subprojects.classes.selectors = class fake:headerfile -qhp.qtdatavisualization.subprojects.classes.sortPages = true - +qhp.qtdatavisualization.filterAttributes = qtdatavisualization 0.1.0 qtrefdoc +qhp.qtdatavisualization.customFilters.Qt.name = QtDataVisualization 0.1.0 +qhp.qtdatavisualization.customFilters.Qt.filterAttributes = qtdatavisualization 0.1.0 +qhp.qtdatavisualization.subprojects = gettingstarted examples classes types +qhp.qtdatavisualization.subprojects.gettingstarted.title = Getting Started +qhp.qtdatavisualization.subprojects.gettingstarted.indexTitle = Qt Data Visualization Getting Started +qhp.qtdatavisualization.subprojects.gettingstarted.selectors = fake:page +qhp.qtdatavisualization.subprojects.gettingstarted.sortPages = true +qhp.qtdatavisualization.subprojects.examples.title = Examples +qhp.qtdatavisualization.subprojects.examples.indexTitle = Qt Data Visualization Examples +qhp.qtdatavisualization.subprojects.examples.selectors = fake:example +qhp.qtdatavisualization.subprojects.examples.sortPages = true +qhp.qtdatavisualization.subprojects.classes.title = C++ Classes +qhp.qtdatavisualization.subprojects.classes.indexTitle = Qt Data Visualization C++ Classes +qhp.qtdatavisualization.subprojects.classes.selectors = class +qhp.qtdatavisualization.subprojects.classes.sortPages = true +qhp.qtdatavisualization.subprojects.types.title = QML Types +qhp.qtdatavisualization.subprojects.types.indexTitle = Qt Data Visualization QML Types +qhp.qtdatavisualization.subprojects.types.selectors = class +qhp.qtdatavisualization.subprojects.types.sortPages = true HTML.footer = \ "
\n" \ @@ -48,4 +59,3 @@ HTML.footer = \ " between you and Digia.\n" \ "

\n" \ "
\n" - 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. */ /*! @@ -35,6 +37,19 @@ \section1 QML Types */ +/*! + \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 @@ -42,13 +57,62 @@ \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: diff --git a/src/datavisualization/global/qtdatavisualizationenums.qdoc b/src/datavisualization/global/qtdatavisualizationenums.qdoc index fde6a258..5f13b5b9 100644 --- a/src/datavisualization/global/qtdatavisualizationenums.qdoc +++ b/src/datavisualization/global/qtdatavisualizationenums.qdoc @@ -20,6 +20,9 @@ \namespace QtDataVisualization \inmodule QtDataVisualization \target QtDataVisualization Enums + + QtDataVisualization namespace holds all the classes and enumerations in the QtDataVisualization + module. */ /*! -- cgit v1.2.3