summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/sensors/qcompass.cpp5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/sensors/qcompass.cpp b/src/sensors/qcompass.cpp
index 8bfca073..6564d362 100644
--- a/src/sensors/qcompass.cpp
+++ b/src/sensors/qcompass.cpp
@@ -56,7 +56,8 @@ IMPLEMENT_READING(QCompassReading)
\section2 QCompassReading Units
The compass returns the azimuth of the device as degrees from
- magnetic north in a clockwise direction based on the top of the UI.
+ magnetic north in a clockwise direction based on the top of the device,
+ as defined by QPlatformScreen::nativeOrientation.
There is also a value to indicate the calibration status of the device.
If the device is not calibrated the azimuth may not be accurate.
@@ -75,7 +76,7 @@ IMPLEMENT_READING(QCompassReading)
\brief the azimuth of the device.
Measured in degrees from magnetic north in a clockwise direction based
- the top of the UI.
+ the top of the device, as defined by QPlatformScreen::nativeOrientation.
\sa {QCompassReading Units}
*/