summaryrefslogtreecommitdiffstats
path: root/basicsuite/SensorExplorer/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2013-12-20 14:56:35 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2014-01-14 15:57:06 +0200
commite80e8e67554708a69d74bab5c22c6644b419eae1 (patch)
tree61728bb1ab1e4171c96f32931dd887dc64bf13f2 /basicsuite/SensorExplorer/doc
parent06ed12c66d7d8a58e37228c3d4785b4070be5d6a (diff)
Introduce documentation for Qt Enterprise Embedded Examples
Create documentation structure for Qt Enterprise Embedded Examples and Demos, including the subprojects from the /basicsuite subdirectory. Task-number: QTEE-137 Change-Id: Ic6f9f9fa8cea8b7fa4821508fda93822c0b99ea3 Reviewed-by: Samuli Piippo <samuli.piippo@digia.com> Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
Diffstat (limited to 'basicsuite/SensorExplorer/doc')
-rw-r--r--basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc34
1 files changed, 11 insertions, 23 deletions
diff --git a/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc b/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc
index be04215..001642f 100644
--- a/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc
+++ b/basicsuite/SensorExplorer/doc/src/sensor_explorer.qdoc
@@ -26,18 +26,18 @@
****************************************************************************/
/*!
- \example sensor_explorer
- \title Qt Sensors - Explorer QML example
- \ingroup qtsensors-examples
+ \example SensorExplorer
+ \title Sensor Explorer
+ \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
+ \ingroup b2qt-demos
\section2 Sensor Explorer in QML
- \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
This example is divided into two parts:
\list
- \li A \l{Sensor Explorer QML Import}{C++ plug-in} that provides QML alternatives for QSensorExplorer, QPropertyInfo and the QSensorItem classes.
+ \li A C++ plug-in that provides QML alternatives for QSensorExplorer, QPropertyInfo and the QSensorItem classes.
\li A QML Application that uses the QML alternatives to read the sensors meta-data and present it.
\endlist
@@ -54,38 +54,26 @@
Import the Explorer 1.0 declarative plugin:
- \snippet sensor_explorer/sensor_explorer.qml 0
+ \snippet SensorExplorer/main.qml 0
Create a SensorExplorer QML item:
- \snippet sensor_explorer/sensor_explorer.qml 1
+ \snippet SensorExplorer/main.qml 1
You can retrieve a list of all available sensors using the SensorExplorer:
- \snippet sensor_explorer/sensor_explorer.qml 2
+ \snippet SensorExplorer/main.qml 2
To retrieve the properties of a SensorItem use:
- \snippet sensor_explorer/sensor_explorer.qml 3
+ \snippet SensorExplorer/main.qml 3
Changing a property value can be done like:
- \snippet sensor_explorer/sensor_explorer.qml 4
+ \snippet SensorExplorer/main.qml 4
Starting and stopping a sensor can be done like:
- \snippet sensor_explorer/sensor_explorer.qml 5
-*/
-
-/*!
- \example sensor_explorer/import
- \title Sensor Explorer QML Import
-
- \section2 Sensor Explorer Declarative Plugin
- \brief The Sensor Explorer QML import exports the QSensorExplorer, QPropertyInfo and the QSensorItem class as a QML type.
-
- This example creates the \e {Explorer 1.0} import.
-
- \sa {Qt Sensors - Explorer QML example}
+ \snippet SensorExplorer/main.qml 5
*/