From 5547ed30de1dda196cd21bd26e5ab2090a970a46 Mon Sep 17 00:00:00 2001 From: Thomas McGuire Date: Fri, 29 Jun 2012 11:54:52 +0200 Subject: Document QIRProximitySensor Change-Id: I369c2408ef6f746ae7931f757f3e8f8602795f1a Reviewed-by: Thomas McGuire Reviewed-by: Lorn Potter --- plugins/declarative/sensors/sensors.cpp | 43 +++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) 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. +*/ -- cgit v1.2.3