diff options
author | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-10-04 14:33:42 +0300 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-10-04 15:37:40 +0300 |
commit | b9b72df8bc8fd7078622661a6576c52627c1b327 (patch) | |
tree | cb3bc5f86d4ee5da14920daf0f23663bd045f540 /src/datavisualization/doc/src | |
parent | af85378b6361d3252d00c5eaea679d031759a2d2 (diff) |
Added getting started documentation.
+Improved example stubs to allow easier listing of them
+Misc fixes
Change-Id: Ib38f63f68a376fd475442d49b525e6b2109733a4
Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src')
-rw-r--r-- | src/datavisualization/doc/src/qtdatavisualization-index.qdoc | 14 | ||||
-rw-r--r-- | src/datavisualization/doc/src/qtdatavisualization.qdoc | 48 |
2 files changed, 48 insertions, 14 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc index 7ec90eaa..f2245c12 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc @@ -46,7 +46,7 @@ \snippet doc_src_qmldatavisualization.cpp 0 If you intend to use Qt Data Visualization C++ classes in your application, use the - following directive: + following include and using directives: \snippet doc_src_qtdatavisualization.cpp 0 @@ -74,15 +74,5 @@ Qt Data Visualization comes with the following examples: - \list - \li \l{Bars Example} - \li \l{Qt Quick 2 Bars Example} - \li \l{Qt Quick 2 Scatter Example} - \li \l{Qt Quick 2 Surface Example} - \li \l{Rainfall Example} - \li \l{Scatter Example} - \li \l{Surface Example} - \li \l{Audiolevels Example} - \li \l{Widget Example} - \endlist + \annotatedlist qtdatavisualization_examples */ diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index c0e317d0..ba158d27 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -41,11 +41,55 @@ \section1 Building Qt Data Visualization - TODO + 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/... + + To build a statically linked version of the Qt Data Visualization module, give the following + commands: + + \snippet doc_src_qtdatavisualization.cpp 7 + + \section1 Running examples + + Qt Data Visualization examples are found under \c examples subdirectory. To build and run a + single example, e.g. the qmlsurface example, navigate to the example directory and give the + following commands: + + \snippet doc_src_qtdatavisualization.cpp 8 + + \note On some platforms, such as Windows, the executable can be generated under debug or + release folders, depending on your build. \section1 Creating a simple application - TODO + To create a simple application, start by creating a new Qt Gui Application project in Qt + Creator and add this line to the \c .pro file of the project: + + \snippet doc_src_qtdatavisualization.pro 0 + + In the \c main.cpp file, include the module headers and declare namespace usage: + + \snippet doc_src_qtdatavisualization.cpp 0 + + Then, add the sample code found in one of the following pages, depending on what kind of + visualization you are interested in: \l{How to construct a minimal Q3DBars graph}, + \l{How to construct a minimal Q3DScatter graph}, or + \l{How to construct a minimal Q3DSurface graph}. + + To use Qt Data Visualization graphs in widget based applications, you can use + QWidget::createWindowContainer() function to wrap the graph into a widget: + + \snippet doc_src_qtdatavisualization.cpp 9 + + For further code examples, see one of the Qt Data Visualization examples: + + \annotatedlist qtdatavisualization_examples */ /*! |