summaryrefslogtreecommitdiffstats
path: root/examples/sensors/qmlsensorgestures/doc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2013-10-09 13:26:10 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-11-04 11:46:55 +0100
commit76d4cae393305a1a87e53b88ef80a2a1a87758b7 (patch)
tree161fac4d236e2434873754322562497ebdb6229f /examples/sensors/qmlsensorgestures/doc
parentb8b341cb805502bd0cc4a61d67aebe9984f59eb4 (diff)
Doc: Clean up SensorGesture QML example
Fix warnings, fix property names and strings shown in the UI. Also touch the documentation and correct a typo in the qdoc file name. Task-number: QTBUG-33877 Change-Id: Ie790708ac4d1f8d72af03b52ee361d0bf3994adc Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>
Diffstat (limited to 'examples/sensors/qmlsensorgestures/doc')
-rw-r--r--examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc (renamed from examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc)41
1 files changed, 23 insertions, 18 deletions
diff --git a/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc b/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc
index 83f3171d..6d810711 100644
--- a/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgtestures.qdoc
+++ b/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc
@@ -30,34 +30,39 @@
\title Qt Sensors - SensorGesture QML Type example
\ingroup qtsensors-examples
- \brief This example demonstrates use of the SensorGesture QML type.
+ \brief Demonstrates the use of SensorGesture QML type.
-\section1 Overview
- To write a QML application that will use the gesture plugin you need to to the following steps:
+ \section1 Overview
+ To write a QML application that will use the gesture plugin, following
+ steps are needed:
- Import the QtSensors 5.x declarative plugin:
+ Import the QtSensors 5.x module:
-\snippet qmlsensorgestures/GestureView.qml 0
+ \snippet qmlsensorgestures/GestureView.qml 0
- Add the SensorGesture QML type into your qml file.
+ Add the SensorGesture QML type into your qml file.
-\snippet qmlsensorgestures/GestureView.qml 1
+ \snippet qmlsensorgestures/GestureView.qml 1
- Each SensorGesture QML type contains a property called gestures.
+ Each SensorGesture QML type contains a property called gestures. This example
+ uses an alias \c gestureId for this property.
- In this example an alias 'gestureid' for this property is used.
+ \snippet qmlsensorgestures/GestureView.qml 2
-\snippet qmlsensorgestures/GestureView.qml 2
+ Then, the gesture or gestures to use can be specified using the alias:
- By using this alias property you define which gestures should be used:
+ \snippet qmlsensorgestures/qmlsensorgestures.qml 3
+ \dots 12
+ \snippet qmlsensorgestures/qmlsensorgestures.qml 4
-\snippet qmlsensorgestures/qmlsensorgestures.qml 3
+ A list of all available gestures is accessible through the
+ \c availableGestures property:
- A list of all available gestures can be created by calling the 'availableGestures' property:
+ \snippet qmlsensorgestures/GestureList.qml 4
+ \codeline
+ \snippet qmlsensorgestures/GestureList.qml 5
+ \dots 12
+ \snippet qmlsensorgestures/GestureList.qml 6
-\snippet qmlsensorgestures/GestureList.qml 4
-
-\sa {Qt Sensors - ShakeIt QML Example}
-\sa {Qt Sensor Gestures}
+ \sa {Qt Sensors - ShakeIt QML Example}, {Qt Sensor Gestures}
*/
-