summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--examples/audiolevels/doc/images/audiolevels-example.pngbin171468 -> 112869 bytes
-rw-r--r--examples/bars/doc/images/bars-example.pngbin381366 -> 256555 bytes
-rw-r--r--examples/customproxy/doc/images/customproxy-example.pngbin266150 -> 121510 bytes
-rw-r--r--examples/itemmodel/doc/images/itemmodel-example-2.pngbin233656 -> 244935 bytes
-rw-r--r--examples/itemmodel/doc/images/itemmodel-example.pngbin151107 -> 122535 bytes
-rw-r--r--examples/qmlbars/doc/images/qmlbars-example.pngbin263992 -> 252315 bytes
-rw-r--r--examples/qmlscatter/doc/images/qmlscatter-example.pngbin190076 -> 84088 bytes
-rw-r--r--examples/qmlscatter/doc/images/qmlscatter-newproject.pngbin104569 -> 123222 bytes
-rw-r--r--examples/qmlsurface/doc/images/qmlsurface-example.pngbin748571 -> 366196 bytes
-rw-r--r--examples/scatter/doc/images/scatter-example.pngbin433068 -> 291267 bytes
-rw-r--r--examples/surface/doc/images/surface-example.pngbin366836 -> 248914 bytes
-rw-r--r--src/datavisualization/doc/qtdatavisualization.qdocconf32
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization.qdoc80
-rw-r--r--src/datavisualization/global/qtdatavisualizationenums.qdoc3
14 files changed, 96 insertions, 19 deletions
diff --git a/examples/audiolevels/doc/images/audiolevels-example.png b/examples/audiolevels/doc/images/audiolevels-example.png
index 47c982d9..6d0e7f8c 100644
--- a/examples/audiolevels/doc/images/audiolevels-example.png
+++ b/examples/audiolevels/doc/images/audiolevels-example.png
Binary files differ
diff --git a/examples/bars/doc/images/bars-example.png b/examples/bars/doc/images/bars-example.png
index fb30a944..8cb1c5de 100644
--- a/examples/bars/doc/images/bars-example.png
+++ b/examples/bars/doc/images/bars-example.png
Binary files differ
diff --git a/examples/customproxy/doc/images/customproxy-example.png b/examples/customproxy/doc/images/customproxy-example.png
index f1b5c443..3dc65bbb 100644
--- a/examples/customproxy/doc/images/customproxy-example.png
+++ b/examples/customproxy/doc/images/customproxy-example.png
Binary files differ
diff --git a/examples/itemmodel/doc/images/itemmodel-example-2.png b/examples/itemmodel/doc/images/itemmodel-example-2.png
index 7186b267..6f903f76 100644
--- a/examples/itemmodel/doc/images/itemmodel-example-2.png
+++ b/examples/itemmodel/doc/images/itemmodel-example-2.png
Binary files differ
diff --git a/examples/itemmodel/doc/images/itemmodel-example.png b/examples/itemmodel/doc/images/itemmodel-example.png
index 03d7c386..26283146 100644
--- a/examples/itemmodel/doc/images/itemmodel-example.png
+++ b/examples/itemmodel/doc/images/itemmodel-example.png
Binary files differ
diff --git a/examples/qmlbars/doc/images/qmlbars-example.png b/examples/qmlbars/doc/images/qmlbars-example.png
index b23491e9..9e3a1abe 100644
--- a/examples/qmlbars/doc/images/qmlbars-example.png
+++ b/examples/qmlbars/doc/images/qmlbars-example.png
Binary files differ
diff --git a/examples/qmlscatter/doc/images/qmlscatter-example.png b/examples/qmlscatter/doc/images/qmlscatter-example.png
index 039c1efc..7ba226fe 100644
--- a/examples/qmlscatter/doc/images/qmlscatter-example.png
+++ b/examples/qmlscatter/doc/images/qmlscatter-example.png
Binary files differ
diff --git a/examples/qmlscatter/doc/images/qmlscatter-newproject.png b/examples/qmlscatter/doc/images/qmlscatter-newproject.png
index b64e6fc6..13b859a3 100644
--- a/examples/qmlscatter/doc/images/qmlscatter-newproject.png
+++ b/examples/qmlscatter/doc/images/qmlscatter-newproject.png
Binary files differ
diff --git a/examples/qmlsurface/doc/images/qmlsurface-example.png b/examples/qmlsurface/doc/images/qmlsurface-example.png
index 32396b40..3aa24ceb 100644
--- a/examples/qmlsurface/doc/images/qmlsurface-example.png
+++ b/examples/qmlsurface/doc/images/qmlsurface-example.png
Binary files differ
diff --git a/examples/scatter/doc/images/scatter-example.png b/examples/scatter/doc/images/scatter-example.png
index d5331e4d..0feaceab 100644
--- a/examples/scatter/doc/images/scatter-example.png
+++ b/examples/scatter/doc/images/scatter-example.png
Binary files differ
diff --git a/examples/surface/doc/images/surface-example.png b/examples/surface/doc/images/surface-example.png
index 591f9c1e..e7009241 100644
--- a/examples/surface/doc/images/surface-example.png
+++ b/examples/surface/doc/images/surface-example.png
Binary files differ
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 = \
"<div class=\"footer\">\n" \
@@ -48,4 +59,3 @@ HTML.footer = \
" between you and Digia.\n" \
" </p>\n" \
"</div>\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.
*/
/*!
@@ -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:
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.
*/
/*!