Skip to content

Commit

Permalink
Doc: Removed QML version from \inqmlmodule and put it in \qmlmodule
Browse files Browse the repository at this point in the history
-QDoc uses \qmlmodule to determine version
-QDoc ignores versions in \inqmlmodule but it is better to remove the
 version to avoid confusion

Task-number: QTBUG-32172
Change-Id: Iccab6b3fe201e8f01ddf130cd985bc0482425bf5
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Reviewed-by: Bernd Weimer <bweimer@blackberry.com>
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
  • Loading branch information
jeromepasion authored and The Qt Project committed Sep 27, 2013
1 parent fc3b839 commit e4ff587
Show file tree
Hide file tree
Showing 21 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlaccelerometer.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype Accelerometer
\instantiates QmlAccelerometer
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The Accelerometer element reports on linear acceleration
Expand Down Expand Up @@ -106,7 +106,7 @@ QSensor *QmlAccelerometer::sensor() const
\qmltype AccelerometerReading
\instantiates QmlAccelerometerReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The AccelerometerReading element holds the most recent Accelerometer reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlaltimeter.cpp
Expand Up @@ -45,7 +45,7 @@
\qmltype Altimeter
\instantiates QmlAltimeter
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits Sensor
\brief The Altimeter element reports on altitude.
Expand Down Expand Up @@ -82,7 +82,7 @@ QSensor *QmlAltimeter::sensor() const
\qmltype AltimeterReading
\instantiates QmlAltimeterReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits SensorReading
\brief The AltimeterReading element holds the most recent Altimeter reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlambientlightsensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype AmbientLightSensor
\instantiates QmlAmbientLightSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The AmbientLightSensor element repors on ambient lighting conditions.
Expand Down Expand Up @@ -83,7 +83,7 @@ QSensor *QmlAmbientLightSensor::sensor() const
\qmltype AmbientLightReading
\instantiates QmlAmbientLightSensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The AmbientLightReading element holds the most AmbientLightSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlambienttemperaturesensor.cpp
Expand Up @@ -45,7 +45,7 @@
\qmltype AmbientTemperatureSensor
\instantiates QmlAmbientTemperatureSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits Sensor
\brief The AmbientTemperatureSensor element reports on the ambient temperature.
Expand Down Expand Up @@ -82,7 +82,7 @@ QSensor *QmlAmbientTemperatureSensor::sensor() const
\qmltype AmbientTemperatureReading
\instantiates QmlAmbientTemperatureReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits SensorReading
\brief The AmbientTemperatureReading element holds the most recent temperature reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlcompass.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype Compass
\instantiates QmlCompass
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The Compass element reports on heading using magnetic north as a reference.
Expand Down Expand Up @@ -83,7 +83,7 @@ QSensor *QmlCompass::sensor() const
\qmltype CompassReading
\instantiates QmlCompassReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The CompassReading element holds the most recent Compass reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlgyroscope.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype Gyroscope
\instantiates QmlGyroscope
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The Gyroscope element reports on rotational acceleration
Expand Down Expand Up @@ -82,7 +82,7 @@ QSensor *QmlGyroscope::sensor() const
\qmltype GyroscopeReading
\instantiates QmlGyroscopeReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The GyroscopeReading element holds the most recent Gyroscope reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlholstersensor.cpp
Expand Up @@ -45,7 +45,7 @@
\qmltype HolsterSensor
\instantiates QmlHolsterSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits Sensor
\brief The HolsterSensor element reports on whether a device is holstered.
Expand Down Expand Up @@ -82,7 +82,7 @@ QSensor *QmlHolsterSensor::sensor() const
\qmltype HolsterReading
\instantiates QmlHolsterReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits SensorReading
\brief The HolsterReading element holds the most recent HolsterSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlirproximitysensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype IRProximitySensor
\instantiates QmlIRProximitySensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The IRProximitySensor element reports on infra-red reflectance values.
Expand Down Expand Up @@ -81,7 +81,7 @@ QSensor *QmlIRProximitySensor::sensor() const
\qmltype IRProximityReading
\instantiates QmlIRProximitySensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The IRProximityReading element holds the most recent IR proximity reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmllightsensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype LightSensor
\instantiates QmlLightSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The LightSensor element reports on light levels using LUX.
Expand Down Expand Up @@ -97,7 +97,7 @@ qreal QmlLightSensor::fieldOfView() const
\qmltype LightReading
\instantiates QmlLightSensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The LightReading element holds the most recent LightSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlmagnetometer.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype Magnetometer
\instantiates QmlMagnetometer
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The Magnetometer element reports on magnetic field strength
Expand Down Expand Up @@ -104,7 +104,7 @@ void QmlMagnetometer::setReturnGeoValues(bool geo)
\qmltype MagnetometerReading
\instantiates QmlMagnetometerReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The MagnetometerReading element holds the most recent Magnetometer reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlorientationsensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype OrientationSensor
\instantiates QmlOrientationSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The OrientationSensor element reports device orientation.
Expand Down Expand Up @@ -83,7 +83,7 @@ QSensor *QmlOrientationSensor::sensor() const
\qmltype OrientationReading
\instantiates QmlOrientationSensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The OrientationReading element holds the most recent OrientationSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlpressuresensor.cpp
Expand Up @@ -45,7 +45,7 @@
\qmltype PressureSensor
\instantiates QmlPressureSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits Sensor
\brief The PressureSensor element reports on atmospheric pressure values.
Expand Down Expand Up @@ -82,7 +82,7 @@ QSensor *QmlPressureSensor::sensor() const
\qmltype PressureReading
\instantiates QmlPressureReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.1
\inherits SensorReading
\brief The PressureReading element holds the most recent PressureSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlproximitysensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype ProximitySensor
\instantiates QmlProximitySensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The ProximitySensor element reports on object proximity.
Expand Down Expand Up @@ -83,7 +83,7 @@ QSensor *QmlProximitySensor::sensor() const
\qmltype ProximityReading
\instantiates QmlProximitySensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The ProximityReading element holds the most recent ProximitySensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlrotationsensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype RotationSensor
\instantiates QmlRotationSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The RotationSensor element reports on device rotation
Expand Down Expand Up @@ -102,7 +102,7 @@ void QmlRotationSensor::_update()
\qmltype RotationReading
\instantiates QmlRotationSensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The RotationReading element holds the most recent RotationSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmlsensor.cpp
Expand Up @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype Sensor
\instantiates QmlSensor
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\brief The Sensor element serves as a base type for sensors.
Expand Down Expand Up @@ -500,7 +500,7 @@ void QmlSensor::updateReading()
/*!
\qmltype SensorReading
\instantiates QmlSensorReading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\brief The SensorReading element serves as a base type for sensor readings.
Expand Down
2 changes: 1 addition & 1 deletion src/imports/sensors/qmlsensorgesture.cpp
Expand Up @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype SensorGesture
\instantiates QmlSensorGesture
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\brief Provides notifications when sensor-based gestures are detected.
Expand Down
2 changes: 1 addition & 1 deletion src/imports/sensors/qmlsensorglobal.cpp
Expand Up @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype SensorGlobal
\instantiates QmlSensorGlobal
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\brief The SensorGlobal element provides the module API.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmltapsensor.cpp
Expand Up @@ -46,7 +46,7 @@
\qmltype TapSensor
\instantiates QmlTapSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The TapSensor element reports tap and double tap events
Expand Down Expand Up @@ -104,7 +104,7 @@ void QmlTapSensor::setReturnDoubleTapEvents(bool ret)
\qmltype TapReading
\instantiates QmlTapSensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The TapReading element holds the most recent TapSensor reading.
Expand Down
4 changes: 2 additions & 2 deletions src/imports/sensors/qmltiltsensor.cpp
Expand Up @@ -49,7 +49,7 @@ QT_END_NAMESPACE
\qmltype TiltSensor
\instantiates QmlTiltSensor
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits Sensor
\brief The TiltSensor element reports tilt events
Expand Down Expand Up @@ -98,7 +98,7 @@ void QmlTiltSensor::calibrate()
\qmltype TiltReading
\instantiates QmlTiltSensorReading
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.0
\inherits SensorReading
\brief The TiltReading element holds the most recent TiltSensor reading.
Expand Down
2 changes: 1 addition & 1 deletion src/sensors/doc/src/qtsensors5.qdoc
Expand Up @@ -41,7 +41,7 @@
*/

/*!
\qmlmodule QtSensors 5
\qmlmodule QtSensors 5.0
\title Qt Sensors QML Types
\ingroup qmlmodules

Expand Down
4 changes: 2 additions & 2 deletions src/sensors/make_sensor.pl
Expand Up @@ -153,7 +153,7 @@
\qmltype '.$no_q_sensor.'
\instantiates '.$qmlsensor.'
\ingroup qml-sensors_type
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.[INSERT VERSION HERE]
\inherits Sensor
\brief The '.$no_q_sensor.' element reports on fubbleness.
Expand Down Expand Up @@ -190,7 +190,7 @@
\qmltype '.$no_q_reading.'
\instantiates '.$qmlreading.'
\ingroup qml-sensors_reading
\inqmlmodule QtSensors 5.0
\inqmlmodule QtSensors
\since QtSensors 5.[INSERT VERSION HERE]
\inherits SensorReading
\brief The '.$no_q_reading.' element holds the most recent '.$no_q_sensor.' reading.
Expand Down

0 comments on commit e4ff587

Please sign in to comment.