summaryrefslogtreecommitdiffstats
path: root/src
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 /src
parent607f545c719486c4ebc1dd3ea227b268d70b8a16 (diff)
improve the sensors docs a bit
Change-Id: I2774c8ecc5ae711b6444d0adff0697c6d278dcad Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'src')
-rw-r--r--src/sensors/qirproximitysensor.cpp8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/sensors/qirproximitysensor.cpp b/src/sensors/qirproximitysensor.cpp
index 95230068..2aedfafb 100644
--- a/src/sensors/qirproximitysensor.cpp
+++ b/src/sensors/qirproximitysensor.cpp
@@ -60,16 +60,16 @@ IMPLEMENT_READING(QIRProximityReading)
\section2 QIRProximityReading Units
- The sensor reports reflectance as a percentage. That is, 0 indicates nothing was detected
- within the range of the sensor and 100 indicates the infra-red signal returned at the full
- power level that it was sent at.
+ The sensor reports reflectance as a decimal fraction in the range of 0 - 1. That is, 0 indicates
+ nothing was detected within the range of the sensor and 1 indicates the infra-red signal
+ returned at the full power level that it was sent at.
*/
/*!
\property QIRProximityReading::reflectance
\brief Holds the reflectance value.
- The reflectance is a percentage (from 0 to 100) indicating how much of the transmitted
+ The reflectance is a decimal fraction (from 0 to 1) indicating how much of the transmitted
infra-red light was returned.
\sa {QIRProximityReading Units}