summaryrefslogtreecommitdiffstats
path: root/doc/src/imports
diff options
context:
space:
mode:
authorLorn Potter <lorn.potter@nokia.com>2012-02-10 10:50:14 +1000
committerQt by Nokia <qt-info@nokia.com>2012-02-12 23:26:15 +0100
commit3b030528fbc3d2d7681113dc6c2727d4cff7a07a (patch)
treeb4988a0bed2179e905af6934b62dc73f0a0a9d07 /doc/src/imports
parent607f545c719486c4ebc1dd3ea227b268d70b8a16 (diff)
improve the sensors docs a bit
Change-Id: I2774c8ecc5ae711b6444d0adff0697c6d278dcad Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'doc/src/imports')
-rw-r--r--doc/src/imports/qtsensors5.qdoc23
1 files changed, 11 insertions, 12 deletions
diff --git a/doc/src/imports/qtsensors5.qdoc b/doc/src/imports/qtsensors5.qdoc
index 2eb6aeb0..6f1a46a4 100644
--- a/doc/src/imports/qtsensors5.qdoc
+++ b/doc/src/imports/qtsensors5.qdoc
@@ -33,23 +33,22 @@
\section1 Overview
The identifying string for this component is \e QtSensors.
- Use this in the QML \e import statement.
+ Use this in the QML import statement, as such: \e import QtSensors 5.0
The QML Sensors 5 Plugin provides an easy to use interface to the Sensors API.
- It enables us to receive sensor events and to read current values from
+ It enables the receiving of sensor events and reading current values from the
sensors.
- The plugin contains many sensor types and properties to read values
- from them. As an example consider the tilt sensor. The qmlsensors2
- simply displays text on-screen to show the current tilt.
+ The plugin contains many sensor types and properties to read values.
+ As an example, consider the tilt sensor. The \l {QML QtSensors example}
+ simply displays text on-screen to show the current tilt value.
- The QML code that reads the value is quite simple. Here we see a QML component
- tilt declared which is an \l TiltSensor element. First
- the sensor is started by setting the running property
- to true. The element receives a signal when the x and y rotation changes and it
- can be picked up by the onXRotationChanged and onYRotationChanged slot. Now the
- xRotation and yRotation property of this element can be
- used to extract the current tilt so that it can be used for further calulations.
+ The QML code to read the value is quite simple. Below is a QML \l TiltSensor element
+ declared with an id of \e tilt. The sensor is started by setting the running
+ property to true. The element receives a signal when the x and y rotation
+ changes and it can be picked up by the onXRotationChanged and onYRotationChanged
+ slot. Now the xRotation and yRotation property of this element can be used to
+ extract the current tilt value so that it can be used for further calculations.
\qml
TiltSensor {