summaryrefslogtreecommitdiffstats
path: root/examples/datavisualization/qmlspectrogram/doc/src
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2014-06-19 09:54:03 +0300
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2014-06-26 10:43:30 +0300
commitec195a34594dea6145af5e8f2fedc2f9401d0f14 (patch)
tree407a1553a16461bd495c25a0b75af5289bd44210 /examples/datavisualization/qmlspectrogram/doc/src
parent03baf7bc0b3bf07625e1111fe50c5262047ee302 (diff)
Polar graph support, phase one
- Polar property for toggling the polar mode - Example added. Example docs will be added in another patch once all of the functionality the example needs has been implemented. - Only surface graph supports polar so far. Scatter to be added later. Change-Id: I54d36f764ac1771ac88f73a5f3a2142f2309f6e8 Reviewed-by: Mika Salmela <mika.salmela@digia.com>
Diffstat (limited to 'examples/datavisualization/qmlspectrogram/doc/src')
-rw-r--r--examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc41
1 files changed, 41 insertions, 0 deletions
diff --git a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc
new file mode 100644
index 00000000..6ebba93b
--- /dev/null
+++ b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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 qmlspectrogram
+ \title Qt Quick 2 Spectrogram Example
+ \ingroup qtdatavisualization_examples
+ \brief Showing spectrogram graph in a QML application.
+
+ The Qt Quick 2 surface example demonstrates how to show a polar and cartesian spectrograms
+ and how to utilize orthographic projection to show them in 2D.
+
+ TODO!!!
+
+ \image qmlspectrogram-example.png
+
+ The focus in this example is on showing how to display spectrograms, so the basic
+ functionality is not explained. For more detailed QML example documentation,
+ see \l{Qt Quick 2 Scatter Example}.
+
+ \section1 TODO
+
+ \snippet qmlspectrogram/qml/qmlspectrogram/main.qml 0
+
+ \section1 Example contents
+*/