summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuha Vuolle <juha.vuolle@insta.fi>2021-07-30 07:27:38 +0300
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-08-02 04:27:43 +0000
commit2116d8e45158fea8cb0ceeb581aa4a9e1368581e (patch)
treee24c497058e68a4d19ddf0883292894a2d721c31
parent0b730e4c2af9cb5829b4663e961eb78180a46002 (diff)
Specify units in the tilt sensor documentation
Task-number: QTBUG-66318 Task-number: QTBUG-92512 Change-Id: Ifaa10eb16006ee9037a8a73eb47176638326fdf2 Reviewed-by: Lorn Potter <lorn.potter@gmail.com> (cherry picked from commit 2c38243d9f4a59260a207170ae799edbd08e3d6e) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/sensors/qtiltsensor.cpp12
1 files changed, 7 insertions, 5 deletions
diff --git a/src/sensors/qtiltsensor.cpp b/src/sensors/qtiltsensor.cpp
index 5c966bb2..0e7f35f8 100644
--- a/src/sensors/qtiltsensor.cpp
+++ b/src/sensors/qtiltsensor.cpp
@@ -63,7 +63,8 @@ IMPLEMENT_READING(QTiltReading)
/*!
\property QTiltReading::yRotation
- \brief This property holds the amount of tilt on the Y axis.
+ \brief This property holds the amount of tilt on the Y axis,
+ measured in degrees.
*/
qreal QTiltReading::yRotation() const
{
@@ -71,7 +72,7 @@ qreal QTiltReading::yRotation() const
}
/*!
- Sets yRotation to \a y.
+ Sets yRotation to \a y degrees.
*/
void QTiltReading::setYRotation(qreal y)
{
@@ -80,7 +81,8 @@ void QTiltReading::setYRotation(qreal y)
/*!
\property QTiltReading::xRotation
- \brief This property holds the amount of tilt on the X axis.
+ \brief This property holds the amount of tilt on the X axis,
+ measured in degrees.
*/
qreal QTiltReading::xRotation() const
@@ -89,7 +91,7 @@ qreal QTiltReading::xRotation() const
}
/*!
- Sets xRotation to \a x.
+ Sets xRotation to \a x degrees.
*/
void QTiltReading::setXRotation(qreal x)
{
@@ -174,7 +176,7 @@ QTiltReading *QTiltSensor::reading() const
}
/*!
- Calibrates the tilt sensor. Uses the current tilt angles as 0.
+ Calibrates the tilt sensor. Uses the current tilt angles as 0 degrees.
*/
void QTiltSensor::calibrate()
{