Fix lots of small qdoc issues in Sensor docs

Change-Id: I26dd869ffac45155d834ac2046edc93dae926aef
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>

4 files changed, 40 insertions, 17 deletions

diff --git a/src/imports/sensors2/qsensor2ambientlight.cpp b/src/imports/sensors2/qsensor2ambientlight.cpp
index 7f9402dd..49f1933f 100644
--- a/src/imports/sensors2/qsensor2ambientlight.cpp
+++ b/src/imports/sensors2/qsensor2ambientlight.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
     \inqmlmodule QtSensors 5
     \ingroup qml-QtSensors5
     \since QtSensors 5.0
-    \brief The AmbientLightSensor element provide an easy access to determine the ambient light by using the ambient light sensor.
+    \brief The AmbientLightSensor element provides easy access to determine the ambient light by using the ambient light sensor.
 
     This element is part of the \bold{QtSensors 5} module.
 */
@@ -86,7 +86,7 @@ QSensor2AmbientLight::~QSensor2AmbientLight()
         \o It is light (eg. internal lights).
     \row
         \o AmbientLightSensor.Bright
-        \o It is bright (eg. shade).
+        \o It is bright (eg. outside but in the shade).
     \row
         \o AmbientLightSensor.Sunny
         \o It is very bright (eg. direct sunlight).
diff --git a/src/imports/sensors2/qsensor2gesture.cpp b/src/imports/sensors2/qsensor2gesture.cpp
index 42fe9947..2185fb09 100644
--- a/src/imports/sensors2/qsensor2gesture.cpp
+++ b/src/imports/sensors2/qsensor2gesture.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass SensorGesture QSensor2Gesture
     \inqmlmodule QtSensors 5
     \since QtSensors 5.0
-    \brief The SensorGesture element provide notification when sensor gestures are triggered.
+    \brief The SensorGesture element provides notification when sensor gestures are triggered.
 
     This element is part of the \bold{QtSensors 5} module.
 
@@ -112,7 +112,7 @@ void QSensor2Gesture::componentComplete()
 */
 
 /*!
-    \qmlproperty QStringList QtSensors5::SensorGesture::availableGestures
+    \qmlproperty stringlist QtSensors5::SensorGesture::availableGestures
     This property can be used to determine all available gestures on the system.
 */
 QStringList QSensor2Gesture::availableGestures()
@@ -121,7 +121,7 @@ QStringList QSensor2Gesture::availableGestures()
 }
 
 /*!
-    \qmlproperty QString QtSensors5::SensorGesture::gestures
+    \qmlproperty string QtSensors5::SensorGesture::gestures
     Set this property to the gestures the application is interested in detecting.
     The properties validGestures and invalidGestures will be set as appropriate immediately.
     The list of available gestures can be found in the availableGestures property.
@@ -151,7 +151,7 @@ void QSensor2Gesture::setGestures(const QStringList& value)
 
 
 /*!
-    \qmlproperty QStringList QtSensors5::SensorGesture::validGestures
+    \qmlproperty stringlist QtSensors5::SensorGesture::validGestures
     This property holds the requested gestures that were found on the system.
 */
 QStringList QSensor2Gesture::validGestures() const
@@ -162,7 +162,7 @@ QStringList QSensor2Gesture::validGestures() const
 }
 
 /*!
-    \qmlproperty QStringList QtSensors5::SensorGesture::invalidGestures
+    \qmlproperty stringlist QtSensors5::SensorGesture::invalidGestures
     This property holds the requested gestures that were not found on the system.
 */
 QStringList QSensor2Gesture::invalidGestures() const
@@ -209,7 +209,7 @@ void QSensor2Gesture::setEnabled(bool value)
 }
 
 /*!
-    \qmlsignal QtSensors5::SensorGesture::detected(QString gesture)
+    \qmlsignal QtSensors5::SensorGesture::detected(string gesture)
     This signal is emitted whenever a gesture is detected.
     The gesture parameter contains the gesture that was detected.
 */
diff --git a/src/imports/sensors2/qsensor2proximity.cpp b/src/imports/sensors2/qsensor2proximity.cpp
index 3aebff11..0166e175 100644
--- a/src/imports/sensors2/qsensor2proximity.cpp
+++ b/src/imports/sensors2/qsensor2proximity.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
     \inqmlmodule QtSensors 5
     \ingroup qml-QtSensors5
     \since QtSensors 5.0
-    \brief The ProximitySensor element provide an easy access to determine if the proximity of the mobile user by using the proximity sensor.
+    \brief The ProximitySensor element provides an easy access to determine if the proximity of the mobile user by using the proximity sensor.
 
     This element is part of the \bold{QtSensors 5} module.
 */
diff --git a/src/imports/sensors2/qsensor2tilt.cpp b/src/imports/sensors2/qsensor2tilt.cpp
index 8cf4a617..e261fe76 100644
--- a/src/imports/sensors2/qsensor2tilt.cpp
+++ b/src/imports/sensors2/qsensor2tilt.cpp
@@ -137,7 +137,7 @@ void QSensor2Tilt::createRunModeDataRateMap()
 }
 
 /*!
-    \qmlproperty bool QtSensors5::TiltSensor::speed
+    \qmlproperty enumeration QtSensors5::TiltSensor::speed
     Holds the speed that the sensor should be run at.
     Default is Slow.
 
@@ -220,7 +220,7 @@ void QSensor2Tilt::setUnit(const QSensor2Tilt::Unit val)
 
 
 /*!
-    \qmlproperty qreal QtSensors5::TiltSensor::yRotation
+    \qmlproperty real QtSensors5::TiltSensor::yRotation
     Holds the rotation arround the y axis.
 
     \table
@@ -240,7 +240,7 @@ qreal QSensor2Tilt::yRotation()
 }
 
 /*!
-    \qmlproperty qreal QtSensors5::TiltSensor::xRotation
+    \qmlproperty real QtSensors5::TiltSensor::xRotation
     Holds the rotation arround the x axis.
     \table
     \row
@@ -281,13 +281,35 @@ inline qreal calcRoll(double Ax, double Ay, double Az)
 }
 
 /*!
-    \qmlproperty qreal QtSensors5::TiltSensor::accuracy
+    \qmlproperty real QtSensors5::TiltSensor::accuracy
     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.
+
+
+    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
+    \header \o Rotation \o notify application \o reason
+    \row \o 0.2424   \o no   \o
+    \row \o 4.34234  \o no   \o
+    \row \o 5.23423  \o no   \o
+    \row \o 6.34324  \o yes  \o because 6.34324 >= 5.5
+    \row \o 7.43264  \o no   \o
+    \row \o 8.24504  \o no   \o
+    \row \o 9.34653  \o no   \o
+    \row \o 10.23476 \o no   \o
+    \row \o 11.43565 \o no   \o
+    \row \o 12.45645 \o yes  \o because 12.45645 - 6.34324 = 6.11321 >= 5.5
+    \endtable
 */
 /*!
-    \qmlsignal QtSensors5::TiltSensor::tiltChanged(qreal deltaX, qreal deltaY)
+    \qmlsignal QtSensors5::TiltSensor::tiltChanged(real deltaX, real deltaY)
     This signal is emitted whenever the change from at leat one of the rotation values was higher than the accuracy.
     The angle value is based on the specified unit (Degree or Radian).
 
@@ -302,11 +324,12 @@ qreal QSensor2Tilt::accuracy()
 void QSensor2Tilt::setAccuracy(qreal val)
 {
     //save in rad to save convertion calc in filter function
-    _radAccuracy = M_PI * val / 180;
+    if (val <= 90 && val >= 0)
+      _radAccuracy = M_PI * val / 180;
 }
 
 /*!
-    \qmlproperty void QtSensors5::TiltSensor::calibrate
+    \qmlmethod void QtSensors5::TiltSensor::calibrate()
     The call of this function calibrates the tilt from x and y to the current position.
 */
 void QSensor2Tilt::calibrate()
@@ -322,7 +345,7 @@ void QSensor2Tilt::calibrate()
 }
 
 /*!
-    \qmlproperty qreal QtSensors5::TiltSensor::settings
+    \qmlproperty real QtSensors5::TiltSensor::settings
     This property contains the setting of the current state.
     It can be used for saving and reloading previously saved calibrations.
 */