summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas McGuire <thomas.mcguire.qnx@kdab.com>2012-06-29 11:54:52 +0200
committerLorn Potter <lorn.potter@gmail.com>2012-11-28 18:22:21 +0100
commit5547ed30de1dda196cd21bd26e5ab2090a970a46 (patch)
treea84895f039de1369e1120817d65467acd357a95b
parente788464f2c698daa618108d45feeec1c23815900 (diff)
Document QIRProximitySensor
Change-Id: I369c2408ef6f746ae7931f757f3e8f8602795f1a Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com> Reviewed-by: Lorn Potter <lorn.potter@gmail.com>
-rw-r--r--plugins/declarative/sensors/sensors.cpp43
1 files changed, 43 insertions, 0 deletions
diff --git a/plugins/declarative/sensors/sensors.cpp b/plugins/declarative/sensors/sensors.cpp
index 0e709638f8..0a0180d925 100644
--- a/plugins/declarative/sensors/sensors.cpp
+++ b/plugins/declarative/sensors/sensors.cpp
@@ -825,4 +825,47 @@ Q_EXPORT_PLUGIN2(qsensorsdeclarativemodule, QT_PREPEND_NAMESPACE(QSensorsDeclara
Please see QGyroscopeReading::z for information about this property.
*/
+/*!
+ \qmlclass IRProximitySensor QIRProximitySensor
+ \ingroup qml-sensors_type
+ \since Mobility 1.3
+ \inherits Sensor
+ \brief The IRProximitySensor type reports on infra-red reflectance values.
+
+ This type wraps the QIRProximitySensor class. Please see the documentation for
+ QIRProximitySensor for details.
+
+ \sa {Sensors QML Limitations}
+*/
+
+/*!
+ \qmlproperty IRProximityReading IRProximitySensor::reading
+ Holds the most recent IR proximity reading.
+ Please see QSensor::reading for information about this property.
+*/
+
+/*!
+ \qmlsignal IRProximitySensor::onReadingChanged()
+ Called when the reading object changes.
+ Please see QSensor::readingChanged() for information about this signal.
+*/
+
+/*!
+ \qmlclass IRProximityReading QIRProximityReading
+ \ingroup qml-sensors_reading
+ \since Mobility 1.3
+ \inherits SensorReading
+ \brief The IRProximityReading type holds the most recent IR proximity reading.
+ The IRProximityReading type holds the most recent IR proximity reading.
+
+ This type wraps the QIRProximityReading class. Please see the documentation for
+ QIRProximityReading for details.
+
+ This type cannot be directly created.
+*/
+
+/*!
+ \qmlproperty qreal IRProximityReading::reflectance
+ Please see QIRProximityReading::reflectance for information about this property.
+*/