summaryrefslogtreecommitdiffstats
path: root/src/imports/sensors2/qsensor2tilt.cpp
diff options
context:
space:
mode:
authorLorn Potter <lorn.potter@nokia.com>2012-03-29 11:09:41 +1000
committerQt by Nokia <qt-info@nokia.com>2012-03-29 05:41:37 +0200
commit6c06a5536ad4dfe72423915c9bf99cd25a6c9b93 (patch)
treeb15763bbd2784ee223e7eb5dbf7faae95d7413c0 /src/imports/sensors2/qsensor2tilt.cpp
parent2646629ea49cf808220ef54c77df613cc9fea474 (diff)
fix up documentation according to the doc guys.
Change-Id: I417e3c57e986f9364f25d5a0e742bd31833de283 Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com> Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'src/imports/sensors2/qsensor2tilt.cpp')
-rw-r--r--src/imports/sensors2/qsensor2tilt.cpp17
1 files changed, 11 insertions, 6 deletions
diff --git a/src/imports/sensors2/qsensor2tilt.cpp b/src/imports/sensors2/qsensor2tilt.cpp
index f1d8a6a9..8593f6d8 100644
--- a/src/imports/sensors2/qsensor2tilt.cpp
+++ b/src/imports/sensors2/qsensor2tilt.cpp
@@ -55,9 +55,16 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtSensors 5
\ingroup qml-QtSensors5
\since QtSensors 5.0
- \brief The TiltSensor element provides tilt datas from x and y rotation of the device using the accelerometer sensor.
+ \brief Provides access to the current X and Y axis rotation angles of the device.
+
+ This element provides tilt data from the rotation around the x and y axis of the device using
+ the accelerometer sensor. Like for a marble and maze game, where the marble is rolled
+ around the screen according to the user tilting the device.
This element is part of the \b{QtSensors 5} module.
+
+ The \l {QML Qt Sensors example} is an example how to use this QML element.
+
*/
QSensor2Tilt::QSensor2Tilt(QObject* parent)
: qsensor2common(parent)
@@ -285,13 +292,11 @@ inline qreal calcRoll(double Ax, double Ay, double Az)
This property contains the accuracy (in degrees) in which the rotation should be measured.
This can be used to minimize signal emiting and therefore saving of performance.
Default value is 1 degree.
- The accuracy value is unsigned and works clockwise and anti-clockwise in X and Y axis rotation directions.
- Accuracy range can be 0 to 90 degrees.
-
-
- E.g.
+ The accuracy value is unsigned and works clockwise and counterclockwise in X and Y axis rotation
+ directions. Accuracy range can be 0 to 90 degrees.
+ For example:
Accuracy 5.5 will notify the client application about an rotation change only if the rotation angle over the X and / or Y axis was changed by 5.5 or more degrees clockwise or anti-clockwise.
\table