From 3b030528fbc3d2d7681113dc6c2727d4cff7a07a Mon Sep 17 00:00:00 2001 From: Lorn Potter Date: Fri, 10 Feb 2012 10:50:14 +1000 Subject: improve the sensors docs a bit Change-Id: I2774c8ecc5ae711b6444d0adff0697c6d278dcad Reviewed-by: Lorn Potter --- src/sensors/qirproximitysensor.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src') 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} -- cgit v1.2.3