From 4756a79d456d2fdd7aa1e5cb562a50165daf3d7f Mon Sep 17 00:00:00 2001 From: Alex Blasche Date: Fri, 26 Sep 2014 11:26:13 +0200 Subject: Add \since tag to QtSensor classes. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit QtSensors was released first by Qt 5.1. A few whitespace changes go along as well to unify the formatting. Change-Id: I6f6e15c95c1a5f33731782e429e87cef68e96e3b Task-number: QTBUG-36775 Reviewed-by: Topi Reiniö --- src/sensors/gestures/qsensorgesture.cpp | 11 ++++++----- src/sensors/gestures/qsensorgesturemanager.cpp | 14 +++++++------- src/sensors/gestures/qsensorgestureplugininterface.cpp | 2 +- src/sensors/gestures/qsensorgesturerecognizer.cpp | 11 ++++++----- src/sensors/qaccelerometer.cpp | 3 +++ src/sensors/qambientlightsensor.cpp | 3 +++ src/sensors/qcompass.cpp | 3 +++ src/sensors/qgyroscope.cpp | 3 +++ src/sensors/qirproximitysensor.cpp | 3 +++ src/sensors/qlightsensor.cpp | 3 +++ src/sensors/qmagnetometer.cpp | 3 +++ src/sensors/qorientationsensor.cpp | 3 +++ src/sensors/qproximitysensor.cpp | 3 +++ src/sensors/qrotationsensor.cpp | 3 +++ src/sensors/qsensor.cpp | 5 +++++ src/sensors/qsensorbackend.cpp | 1 + src/sensors/qsensorplugin.cpp | 2 ++ src/sensors/qtapsensor.cpp | 3 +++ src/sensors/qtiltsensor.cpp | 3 +++ 19 files changed, 64 insertions(+), 18 deletions(-) diff --git a/src/sensors/gestures/qsensorgesture.cpp b/src/sensors/gestures/qsensorgesture.cpp index 90f8eedd..97ad8026 100644 --- a/src/sensors/gestures/qsensorgesture.cpp +++ b/src/sensors/gestures/qsensorgesture.cpp @@ -42,11 +42,12 @@ #include /*! - \class QSensorGesture - \ingroup sensorgestures_main - \inmodule QtSensors + \class QSensorGesture + \ingroup sensorgestures_main + \inmodule QtSensors + \since 5.1 - \brief The QSensorGesture class represents one or more sensor gesture recognizers. + \brief The QSensorGesture class represents one or more sensor gesture recognizers. In addition to the QSensorGesture::detected() signal, Sensor Gesture Recognizers can have their own specific signals, and may be discovered through @@ -59,7 +60,7 @@ \sa QSensorGestureRecognizer - You may use QSensorGestureManager to obtain the systems known sensor gesture ids. + You may use QSensorGestureManager to obtain the systems known sensor gesture ids. \sa QSensorGestureManager */ diff --git a/src/sensors/gestures/qsensorgesturemanager.cpp b/src/sensors/gestures/qsensorgesturemanager.cpp index 6a9f4934..e86d7b69 100644 --- a/src/sensors/gestures/qsensorgesturemanager.cpp +++ b/src/sensors/gestures/qsensorgesturemanager.cpp @@ -37,17 +37,17 @@ QT_BEGIN_NAMESPACE /*! - \class QSensorGestureManager - \ingroup sensorgestures_main - \inmodule QtSensors + \class QSensorGestureManager + \ingroup sensorgestures_main + \inmodule QtSensors + \since 5.1 - \brief The QSensorGestureManager class manages sensor gestures, registers and creates sensor gesture plugins. + \brief The QSensorGestureManager class manages sensor gestures, registers and creates sensor gesture plugins. - Sensor Gesture plugins register their recognizers using the registerSensorGestureRecognizer() function. + Sensor Gesture plugins register their recognizers using the registerSensorGestureRecognizer() function. \snippet sensorgestures/creating.cpp Receiving sensor gesture signals - - */ +*/ /*! \fn QSensorGestureManager::newSensorGestureAvailable() diff --git a/src/sensors/gestures/qsensorgestureplugininterface.cpp b/src/sensors/gestures/qsensorgestureplugininterface.cpp index b7cbeca5..7f2657e3 100644 --- a/src/sensors/gestures/qsensorgestureplugininterface.cpp +++ b/src/sensors/gestures/qsensorgestureplugininterface.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE \brief The QSensorGesturePluginInterface class is the pure virtual interface to sensor gesture plugins. - \since 5.0 + \since 5.1 The QSensorGesturePluginInterface class is implemented in sensor gesture plugins to register sensor gesture recognizers with QSensorGestureManager. diff --git a/src/sensors/gestures/qsensorgesturerecognizer.cpp b/src/sensors/gestures/qsensorgesturerecognizer.cpp index bd2c0d0b..48b0fc39 100644 --- a/src/sensors/gestures/qsensorgesturerecognizer.cpp +++ b/src/sensors/gestures/qsensorgesturerecognizer.cpp @@ -41,12 +41,13 @@ QT_BEGIN_NAMESPACE /*! - \class QSensorGestureRecognizer - \ingroup sensorgestures_recognizer - \inmodule QtSensors + \class QSensorGestureRecognizer + \ingroup sensorgestures_recognizer + \inmodule QtSensors + \since 5.1 - \brief The QSensorGestureRecognizer class is the base class for a sensor gesture - recognizer. + \brief The QSensorGestureRecognizer class is the base class for a sensor gesture + recognizer. QSensorGesture recognizer developers should sub-class this to implement their own recognizer. diff --git a/src/sensors/qaccelerometer.cpp b/src/sensors/qaccelerometer.cpp index ef838364..0a17b365 100644 --- a/src/sensors/qaccelerometer.cpp +++ b/src/sensors/qaccelerometer.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QAccelerometerReading) \class QAccelerometerReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QAccelerometerReading class reports on linear acceleration along the X, Y and Z axes. @@ -127,6 +128,7 @@ void QAccelerometerReading::setZ(qreal z) \class QAccelerometerFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QAccelerometerFilter class is a convenience wrapper around QSensorFilter. @@ -176,6 +178,7 @@ char const * const QAccelerometer::type("QAccelerometer"); \class QAccelerometer \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QAccelerometer class is a convenience wrapper around QSensor. diff --git a/src/sensors/qambientlightsensor.cpp b/src/sensors/qambientlightsensor.cpp index 36beb3cf..a899042d 100644 --- a/src/sensors/qambientlightsensor.cpp +++ b/src/sensors/qambientlightsensor.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QAmbientLightReading) \class QAmbientLightReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QAmbientLightReading class represents one reading from the ambient light sensor. @@ -103,6 +104,7 @@ void QAmbientLightReading::setLightLevel(QAmbientLightReading::LightLevel lightL \class QAmbientLightFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QAmbientLightFilter class is a convenience wrapper around QSensorFilter. @@ -129,6 +131,7 @@ char const * const QAmbientLightSensor::type("QAmbientLightSensor"); \class QAmbientLightSensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QAmbientLightSensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qcompass.cpp b/src/sensors/qcompass.cpp index 56dc90c9..34cf5ed9 100644 --- a/src/sensors/qcompass.cpp +++ b/src/sensors/qcompass.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QCompassReading) \class QCompassReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QCompassReading class represents one reading from a compass. @@ -114,6 +115,7 @@ void QCompassReading::setCalibrationLevel(qreal calibrationLevel) \class QCompassFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QCompassFilter class is a convenience wrapper around QSensorFilter. @@ -140,6 +142,7 @@ char const * const QCompass::type("QCompass"); \class QCompass \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QCompass class is a convenience wrapper around QSensor. diff --git a/src/sensors/qgyroscope.cpp b/src/sensors/qgyroscope.cpp index 5180769d..98eba07b 100644 --- a/src/sensors/qgyroscope.cpp +++ b/src/sensors/qgyroscope.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QGyroscopeReading) \class QGyroscopeReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QGyroscopeReading class represents one reading from the gyroscope sensor. @@ -125,6 +126,7 @@ void QGyroscopeReading::setZ(qreal z) \class QGyroscopeFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QGyroscopeFilter class is a convenience wrapper around QSensorFilter. @@ -151,6 +153,7 @@ char const * const QGyroscope::type("QGyroscope"); \class QGyroscope \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QGyroscope class is a convenience wrapper around QSensor. diff --git a/src/sensors/qirproximitysensor.cpp b/src/sensors/qirproximitysensor.cpp index 51e93851..546fcea4 100644 --- a/src/sensors/qirproximitysensor.cpp +++ b/src/sensors/qirproximitysensor.cpp @@ -40,6 +40,7 @@ IMPLEMENT_READING(QIRProximityReading) \class QIRProximityReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QIRProximityReading class holds readings from the IR proximity sensor. @@ -91,6 +92,7 @@ void QIRProximityReading::setReflectance(qreal reflectance) \class QIRProximityFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QIRProximityFilter class is a convenience wrapper around QSensorFilter. @@ -117,6 +119,7 @@ char const * const QIRProximitySensor::type("QIRProximitySensor"); \class QIRProximitySensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QIRProximitySensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qlightsensor.cpp b/src/sensors/qlightsensor.cpp index 231996e3..0bd2c14a 100644 --- a/src/sensors/qlightsensor.cpp +++ b/src/sensors/qlightsensor.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QLightReading) \class QLightReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QLightReading class represents one reading from the light sensor. @@ -77,6 +78,7 @@ void QLightReading::setLux(qreal lux) \class QLightFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QLightFilter class is a convenience wrapper around QSensorFilter. @@ -103,6 +105,7 @@ char const * const QLightSensor::type("QLightSensor"); \class QLightSensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QLightSensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qmagnetometer.cpp b/src/sensors/qmagnetometer.cpp index 2213adbc..f73dd081 100644 --- a/src/sensors/qmagnetometer.cpp +++ b/src/sensors/qmagnetometer.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QMagnetometerReading) \class QMagnetometerReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QMagnetometerReading class represents one reading from the magnetometer. @@ -165,6 +166,7 @@ void QMagnetometerReading::setCalibrationLevel(qreal calibrationLevel) \class QMagnetometerFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QMagnetometerFilter class is a convenience wrapper around QSensorFilter. @@ -191,6 +193,7 @@ char const * const QMagnetometer::type("QMagnetometer"); \class QMagnetometer \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QMagnetometer class is a convenience wrapper around QSensor. diff --git a/src/sensors/qorientationsensor.cpp b/src/sensors/qorientationsensor.cpp index 10db1329..d9460ff1 100644 --- a/src/sensors/qorientationsensor.cpp +++ b/src/sensors/qorientationsensor.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QOrientationReading) \class QOrientationReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QOrientationReading class represents one reading from the orientation sensor. @@ -126,6 +127,7 @@ void QOrientationReading::setOrientation(QOrientationReading::Orientation orient \class QOrientationFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QOrientationFilter class is a convenience wrapper around QSensorFilter. @@ -152,6 +154,7 @@ char const * const QOrientationSensor::type("QOrientationSensor"); \class QOrientationSensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QOrientationSensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qproximitysensor.cpp b/src/sensors/qproximitysensor.cpp index 94ecbf65..93ff48fb 100644 --- a/src/sensors/qproximitysensor.cpp +++ b/src/sensors/qproximitysensor.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QProximityReading) \class QProximityReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QProximityReading class represents one reading from the proximity sensor. @@ -82,6 +83,7 @@ void QProximityReading::setClose(bool close) \class QProximityFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QProximityFilter class is a convenience wrapper around QSensorFilter. @@ -108,6 +110,7 @@ char const * const QProximitySensor::type("QProximitySensor"); \class QProximitySensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QProximitySensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qrotationsensor.cpp b/src/sensors/qrotationsensor.cpp index 3526438c..b80ab7ed 100644 --- a/src/sensors/qrotationsensor.cpp +++ b/src/sensors/qrotationsensor.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QRotationReading) \class QRotationReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QRotationReading class represents one reading from the rotation sensor. @@ -156,6 +157,7 @@ void QRotationReading::setFromEuler(qreal x, qreal y, qreal z) \class QRotationFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QRotationFilter class is a convenience wrapper around QSensorFilter. @@ -182,6 +184,7 @@ char const * const QRotationSensor::type("QRotationSensor"); \class QRotationSensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QRotationSensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qsensor.cpp b/src/sensors/qsensor.cpp index 75c612d3..e584afc8 100644 --- a/src/sensors/qsensor.cpp +++ b/src/sensors/qsensor.cpp @@ -44,6 +44,7 @@ QT_BEGIN_NAMESPACE /*! \typedef qrange \relates QSensor + \since 5.1 This type is defined as a QPair. @@ -57,6 +58,7 @@ QT_BEGIN_NAMESPACE /*! \typedef qrangelist \relates QSensor + \since 5.1 This type is defined as a list of qrange values. @@ -72,6 +74,7 @@ QT_BEGIN_NAMESPACE \relates QSensor \inmodule QtSensors \brief The qoutputrange class holds the specifics of an output range. + \since 5.1 The class is defined as a simple struct. @@ -125,6 +128,7 @@ QT_BEGIN_NAMESPACE /*! \typedef qoutputrangelist \relates QSensor + \since 5.1 This type is defined as a list of qoutputrange values. @@ -156,6 +160,7 @@ void QSensorPrivate::init(const QByteArray &sensorType) \class QSensor \ingroup sensors_main \inmodule QtSensors + \since 5.1 \brief The QSensor class represents a single hardware sensor. diff --git a/src/sensors/qsensorbackend.cpp b/src/sensors/qsensorbackend.cpp index 37ff30b5..bea7509c 100644 --- a/src/sensors/qsensorbackend.cpp +++ b/src/sensors/qsensorbackend.cpp @@ -42,6 +42,7 @@ QT_BEGIN_NAMESPACE \class QSensorBackend \ingroup sensors_backend \inmodule QtSensors + \since 5.1 \brief The QSensorBackend class is a sensor implementation. diff --git a/src/sensors/qsensorplugin.cpp b/src/sensors/qsensorplugin.cpp index cf34974e..8f6856e4 100644 --- a/src/sensors/qsensorplugin.cpp +++ b/src/sensors/qsensorplugin.cpp @@ -37,6 +37,7 @@ \class QSensorPluginInterface \ingroup sensors_backend \inmodule QtSensors + \since 5.1 \brief The QSensorPluginInterface class is the pure virtual interface to sensor plugins. The QSensorPluginInterface class is implemented in sensor plugins to register sensor @@ -67,6 +68,7 @@ QSensorPluginInterface::~QSensorPluginInterface() \class QSensorChangesInterface \ingroup sensors_backend \inmodule QtSensors + \since 5.1 \brief The QSensorChangesInterface class is the pure virtual interface to sensor plugins. The QSensorChangesInterface class is implemented in sensor plugins to receive notification diff --git a/src/sensors/qtapsensor.cpp b/src/sensors/qtapsensor.cpp index 5d0061ac..2c0f4fb6 100644 --- a/src/sensors/qtapsensor.cpp +++ b/src/sensors/qtapsensor.cpp @@ -42,6 +42,7 @@ IMPLEMENT_READING(QTapReading) \class QTapReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QTapReading class represents one reading from the tap sensor. @@ -166,6 +167,7 @@ void QTapReading::setDoubleTap(bool doubleTap) \class QTapFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QTapFilter class is a convenience wrapper around QSensorFilter. @@ -192,6 +194,7 @@ char const * const QTapSensor::type("QTapSensor"); \class QTapSensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QTapSensor class is a convenience wrapper around QSensor. diff --git a/src/sensors/qtiltsensor.cpp b/src/sensors/qtiltsensor.cpp index 14a1c2fd..a9a9e32a 100644 --- a/src/sensors/qtiltsensor.cpp +++ b/src/sensors/qtiltsensor.cpp @@ -46,6 +46,7 @@ IMPLEMENT_READING(QTiltReading) \class QTiltReading \ingroup sensors_reading \inmodule QtSensors + \since 5.1 \brief The QTiltReading class holds readings from the tilt sensor. @@ -95,6 +96,7 @@ void QTiltReading::setXRotation(qreal x) \class QTiltFilter \ingroup sensors_filter \inmodule QtSensors + \since 5.1 \brief The QTiltFilter class is a convenience wrapper around QSensorFilter. @@ -121,6 +123,7 @@ char const * const QTiltSensor::type("QTiltSensor"); \class QTiltSensor \ingroup sensors_type \inmodule QtSensors + \since 5.1 \brief The QTiltSensor class is a convenience wrapper around QSensor. -- cgit v1.2.3