diff options
author | Lincoln Ramsay <lincoln.ramsay@nokia.com> | 2011-12-19 13:21:14 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-12-19 07:01:05 +0100 |
commit | b10e502244fb8d2aedc9edf84c67fb3c263853aa (patch) | |
tree | e7277be2340ffda2119bd314bc65904eab5aab9b /src | |
parent | 6ba0e4d8fa1bd69b1f6813c9b28dd60e00d13c01 (diff) |
QIRProximity... classes should be documented
When pulled in, these files had /* instead of /*! markers which qdoc
ignores.
Change-Id: I346bd0d472ca37ffe460b661edaca522388b46b3
Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/sensors/qirproximitysensor.cpp | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/sensors/qirproximitysensor.cpp b/src/sensors/qirproximitysensor.cpp index 54467b4b..2f95609f 100644 --- a/src/sensors/qirproximitysensor.cpp +++ b/src/sensors/qirproximitysensor.cpp @@ -44,7 +44,7 @@ IMPLEMENT_READING(QIRProximityReading) -/* +/*! \class QIRProximityReading \ingroup sensors_reading \inmodule QtSensors @@ -65,7 +65,7 @@ IMPLEMENT_READING(QIRProximityReading) power level that it was sent at. */ -/* +/*! \property QIRProximityReading::reflectance \brief Holds the reflectance value. @@ -79,7 +79,7 @@ qreal QIRProximityReading::reflectance() const return d->reflectance; } -/* +/*! Sets the reflectance value to \a reflectance. */ void QIRProximityReading::setReflectance(qreal reflectance) @@ -89,7 +89,7 @@ void QIRProximityReading::setReflectance(qreal reflectance) // ===================================================================== -/* +/*! \class QIRProximityFilter \ingroup sensors_filter \inmodule QtSensors @@ -100,7 +100,7 @@ void QIRProximityReading::setReflectance(qreal reflectance) instead of QSensorReading. */ -/* +/*! \fn QIRProximityFilter::filter(QIRProximityReading *reading) Called when \a reading changes. Returns false to prevent the reading from propagating. @@ -110,7 +110,7 @@ void QIRProximityReading::setReflectance(qreal reflectance) char const * const QIRProximitySensor::type("QIRProximitySensor"); -/* +/*! \class QIRProximitySensor \ingroup sensors_type \inmodule QtSensors @@ -126,19 +126,19 @@ char const * const QIRProximitySensor::type("QIRProximitySensor"); \sa QIRProximityReading */ -/* +/*! \fn QIRProximitySensor::QIRProximitySensor(QObject *parent) Construct the sensor as a child of \a parent. */ -/* +/*! \fn QIRProximitySensor::~QIRProximitySensor() Destroy the sensor. Stops the sensor if it has not already been stopped. */ -/* +/*! \fn QIRProximitySensor::reading() const Returns the reading class for this sensor. |