summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-04 14:33:42 +0300
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-04 15:37:40 +0300
commitb9b72df8bc8fd7078622661a6576c52627c1b327 (patch)
treecb3bc5f86d4ee5da14920daf0f23663bd045f540 /examples
parentaf85378b6361d3252d00c5eaea679d031759a2d2 (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 'examples')
-rw-r--r--examples/audiolevels/doc/src/audiolevels.qdoc2
-rw-r--r--examples/bars/doc/src/bars.qdoc2
-rw-r--r--examples/qmlbars/doc/src/qmlbars.qdoc2
-rw-r--r--examples/qmlscatter/doc/src/qmlscatter.qdoc2
-rw-r--r--examples/qmlsurface/doc/src/qmlsurface.qdoc2
-rw-r--r--examples/rainfall/doc/src/rainfall.qdoc2
-rw-r--r--examples/scatter/doc/src/scatter.qdoc2
-rw-r--r--examples/surface/doc/src/surface.qdoc31
-rw-r--r--examples/surface/surface.pro3
-rw-r--r--examples/widget/doc/src/widget.qdoc2
10 files changed, 50 insertions, 0 deletions
diff --git a/examples/audiolevels/doc/src/audiolevels.qdoc b/examples/audiolevels/doc/src/audiolevels.qdoc
index 0ac9de78..0d8144a6 100644
--- a/examples/audiolevels/doc/src/audiolevels.qdoc
+++ b/examples/audiolevels/doc/src/audiolevels.qdoc
@@ -19,6 +19,8 @@
/*!
\example audiolevels
\title Audiolevels Example
+ \ingroup qtdatavisualization_examples
+ \brief Simple application showing real time audio data.
The audiolevels example shows how feed dynamic data to a graph using Q3DBars.
diff --git a/examples/bars/doc/src/bars.qdoc b/examples/bars/doc/src/bars.qdoc
index 8a9a4458..1db72e47 100644
--- a/examples/bars/doc/src/bars.qdoc
+++ b/examples/bars/doc/src/bars.qdoc
@@ -19,6 +19,8 @@
/*!
\example bars
\title Bars Example
+ \ingroup qtdatavisualization_examples
+ \brief Using an item model as data source for Q3DBars.
The bars example shows how to make a simple 3D bar graph using Q3DBars.
diff --git a/examples/qmlbars/doc/src/qmlbars.qdoc b/examples/qmlbars/doc/src/qmlbars.qdoc
index e382bb6b..c9fb564a 100644
--- a/examples/qmlbars/doc/src/qmlbars.qdoc
+++ b/examples/qmlbars/doc/src/qmlbars.qdoc
@@ -19,6 +19,8 @@
/*!
\example qmlbars
\title Qt Quick 2 Bars Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Bars3D in a QML application.
The Qt Quick 2 bars example shows how to make a simple 3D bar graph using Q3DBars and Qt
Quick 2.
diff --git a/examples/qmlscatter/doc/src/qmlscatter.qdoc b/examples/qmlscatter/doc/src/qmlscatter.qdoc
index 590b9a30..e5bb10ad 100644
--- a/examples/qmlscatter/doc/src/qmlscatter.qdoc
+++ b/examples/qmlscatter/doc/src/qmlscatter.qdoc
@@ -19,6 +19,8 @@
/*!
\example qmlscatter
\title Qt Quick 2 Scatter Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Scatter3D in a QML application.
The Qt Quick 2 scatter example shows how to make a simple scatter graph visualization using
Q3DScatter and Qt Quick 2.
diff --git a/examples/qmlsurface/doc/src/qmlsurface.qdoc b/examples/qmlsurface/doc/src/qmlsurface.qdoc
index c589d55a..dba40327 100644
--- a/examples/qmlsurface/doc/src/qmlsurface.qdoc
+++ b/examples/qmlsurface/doc/src/qmlsurface.qdoc
@@ -19,6 +19,8 @@
/*!
\example qmlsurface
\title Qt Quick 2 Surface Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Surface3D in a QML application.
The Qt Quick 2 surface example shows how to make a simple 3D surface plot using Q3DSurface with
Qt Quick 2.
diff --git a/examples/rainfall/doc/src/rainfall.qdoc b/examples/rainfall/doc/src/rainfall.qdoc
index c28029a4..aef14576 100644
--- a/examples/rainfall/doc/src/rainfall.qdoc
+++ b/examples/rainfall/doc/src/rainfall.qdoc
@@ -19,6 +19,8 @@
/*!
\example rainfall
\title Rainfall Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Q3DBars in an application.
The bars example shows how to make a simple 3D bar graph using Q3DBars.
diff --git a/examples/scatter/doc/src/scatter.qdoc b/examples/scatter/doc/src/scatter.qdoc
index 7f4bda38..5053d77a 100644
--- a/examples/scatter/doc/src/scatter.qdoc
+++ b/examples/scatter/doc/src/scatter.qdoc
@@ -19,6 +19,8 @@
/*!
\example scatter
\title Scatter Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Q3DScatter in a widget application.
The scatter example shows how to make a simple 3D scatter graph using Q3DScatter and
combining the use of widgets for adjusting several adjustable qualities.
diff --git a/examples/surface/doc/src/surface.qdoc b/examples/surface/doc/src/surface.qdoc
new file mode 100644
index 00000000..7810c543
--- /dev/null
+++ b/examples/surface/doc/src/surface.qdoc
@@ -0,0 +1,31 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+/*!
+ \example surface
+ \title Surface Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Q3DSurface in a widget application.
+
+ The surface example shows how to make a simple 3D surface graph using Q3DSurface and
+ combining the use of widgets for adjusting several adjustable qualities.
+
+ \image surface-example.png
+
+ TODO
+*/
diff --git a/examples/surface/surface.pro b/examples/surface/surface.pro
index 54302d6b..20c8a1a8 100644
--- a/examples/surface/surface.pro
+++ b/examples/surface/surface.pro
@@ -12,3 +12,6 @@ QT += widgets
INSTALLS += target
RESOURCES += surface.qrc
+
+OTHER_FILES += doc/src/* \
+ doc/images/*
diff --git a/examples/widget/doc/src/widget.qdoc b/examples/widget/doc/src/widget.qdoc
index e0c0f14b..12d621fa 100644
--- a/examples/widget/doc/src/widget.qdoc
+++ b/examples/widget/doc/src/widget.qdoc
@@ -19,6 +19,8 @@
/*!
\example widget
\title Widget Example
+ \ingroup qtdatavisualization_examples
+ \brief Using Q3DBars in a widget application.
The widget example shows how to make a 3D bar graph using Q3DBars and combining the use of
widgets for adjusting several adjustable qualities.