summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorCasper van Donderen <casper.vandonderen@nokia.com>2012-03-01 19:13:17 +0100
committerQt by Nokia <qt-info@nokia.com>2012-03-01 20:10:11 +0100
commit87a6a468c35a557a33de432b784c5911cff561ec (patch)
tree38941a17c03183ae508fb739be531f49e55f4925 /src
parent1c99076a1f55a28ac6c745d1df05226401f11107 (diff)
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold and list items. This change applies that change in QDoc to the actual documentation. Task-number: QTBUG-24578 Change-Id: I9e809abef666b8498bc481aae9f324b954eff387 Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'src')
-rw-r--r--src/imports/sensors2/qsensor2ambientlight.cpp26
-rw-r--r--src/imports/sensors2/qsensor2gesture.cpp2
-rw-r--r--src/imports/sensors2/qsensor2proximity.cpp2
-rw-r--r--src/imports/sensors2/qsensor2tilt.cpp58
-rw-r--r--src/sensors/gestures/qsensorgesture.cpp2
-rw-r--r--src/sensors/qrotationsensor.cpp6
-rw-r--r--src/sensors/qsensor.cpp12
-rw-r--r--src/sensors/qtapsensor.cpp4
8 files changed, 56 insertions, 56 deletions
diff --git a/src/imports/sensors2/qsensor2ambientlight.cpp b/src/imports/sensors2/qsensor2ambientlight.cpp
index 49f1933f..6a4fe0e1 100644
--- a/src/imports/sensors2/qsensor2ambientlight.cpp
+++ b/src/imports/sensors2/qsensor2ambientlight.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
\since QtSensors 5.0
\brief The AmbientLightSensor element provides easy access to determine the ambient light by using the ambient light sensor.
- This element is part of the \bold{QtSensors 5} module.
+ This element is part of the \b{QtSensors 5} module.
*/
QSensor2AmbientLight::QSensor2AmbientLight(QObject* parent)
: qsensor2common(parent)
@@ -73,23 +73,23 @@ QSensor2AmbientLight::~QSensor2AmbientLight()
\table
\row
- \o AmbientLightSensor.Unknown
- \o Ambient light value is not set yet.
+ \li AmbientLightSensor.Unknown
+ \li Ambient light value is not set yet.
\row
- \o AmbientLightSensor.Dark
- \o It is dark.
+ \li AmbientLightSensor.Dark
+ \li It is dark.
\row
- \o AmbientLightSensor.Twilight
- \o It is moderately dark.
+ \li AmbientLightSensor.Twilight
+ \li It is moderately dark.
\row
- \o AmbientLightSensor.Light
- \o It is light (eg. internal lights).
+ \li AmbientLightSensor.Light
+ \li It is light (eg. internal lights).
\row
- \o AmbientLightSensor.Bright
- \o It is bright (eg. outside but in the shade).
+ \li AmbientLightSensor.Bright
+ \li It is bright (eg. outside but in the shade).
\row
- \o AmbientLightSensor.Sunny
- \o It is very bright (eg. direct sunlight).
+ \li AmbientLightSensor.Sunny
+ \li It is very bright (eg. direct sunlight).
\endtable
*/
QSensor2AmbientLight::LightLevel QSensor2AmbientLight::lightLevel()
diff --git a/src/imports/sensors2/qsensor2gesture.cpp b/src/imports/sensors2/qsensor2gesture.cpp
index 0730e565..a1cc39c9 100644
--- a/src/imports/sensors2/qsensor2gesture.cpp
+++ b/src/imports/sensors2/qsensor2gesture.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\since QtSensors 5.0
\brief The SensorGesture element provides notification when sensor gestures are triggered.
- This element is part of the \bold{QtSensors 5} module.
+ This element is part of the \b{QtSensors 5} module.
The following QML code creates a "shake" and "template" SensorGesture QML element.
diff --git a/src/imports/sensors2/qsensor2proximity.cpp b/src/imports/sensors2/qsensor2proximity.cpp
index 0166e175..ac2cf30a 100644
--- a/src/imports/sensors2/qsensor2proximity.cpp
+++ b/src/imports/sensors2/qsensor2proximity.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
\since QtSensors 5.0
\brief The ProximitySensor element provides an easy access to determine if the proximity of the mobile user by using the proximity sensor.
- This element is part of the \bold{QtSensors 5} module.
+ This element is part of the \b{QtSensors 5} module.
*/
QSensor2Proximity::QSensor2Proximity(QObject* parent)
diff --git a/src/imports/sensors2/qsensor2tilt.cpp b/src/imports/sensors2/qsensor2tilt.cpp
index e261fe76..f1d8a6a9 100644
--- a/src/imports/sensors2/qsensor2tilt.cpp
+++ b/src/imports/sensors2/qsensor2tilt.cpp
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
\since QtSensors 5.0
\brief The TiltSensor element provides tilt datas from x and y rotation of the device using the accelerometer sensor.
- This element is part of the \bold{QtSensors 5} module.
+ This element is part of the \b{QtSensors 5} module.
*/
QSensor2Tilt::QSensor2Tilt(QObject* parent)
: qsensor2common(parent)
@@ -143,17 +143,17 @@ void QSensor2Tilt::createRunModeDataRateMap()
\table
\row
- \o TiltSensor.Slow
- \o The sensor runs in slow mode.
- \o Closest available datarate at 2Hz.
+ \li TiltSensor.Slow
+ \li The sensor runs in slow mode.
+ \li Closest available datarate at 2Hz.
\row
- \o TiltSensor.Medium
- \o The sensor runs in medium mode.
- \o Closest available datarate at 10Hz.
+ \li TiltSensor.Medium
+ \li The sensor runs in medium mode.
+ \li Closest available datarate at 10Hz.
\row
- \o TiltSensor.Fast
- \o The sensor runs in fast mode.
- \o Closest available datarate at 20Hz.
+ \li TiltSensor.Fast
+ \li The sensor runs in fast mode.
+ \li Closest available datarate at 20Hz.
\endtable
*/
QSensor2Tilt::Speed QSensor2Tilt::speed()
@@ -198,11 +198,11 @@ void QSensor2Tilt::setEnabled(const bool val)
Returns the unit of the rotation which can be one of:
\table
\row
- \o TiltSensor.Radians
- \o The unit of the rotation angle is radians.
+ \li TiltSensor.Radians
+ \li The unit of the rotation angle is radians.
\row
- \o TiltSensor.Degrees
- \o The unit of the rotation angle is degrees.
+ \li TiltSensor.Degrees
+ \li The unit of the rotation angle is degrees.
\endtable
*/
QSensor2Tilt::Unit QSensor2Tilt::unit()
@@ -225,9 +225,9 @@ void QSensor2Tilt::setUnit(const QSensor2Tilt::Unit val)
\table
\row
- \o
+ \li
\image YAngle.gif
- \o
+ \li
\image YAngleNegative.gif
\endtable
*/
@@ -244,9 +244,9 @@ qreal QSensor2Tilt::yRotation()
Holds the rotation arround the x axis.
\table
\row
- \o
+ \li
\image XAngle.gif
- \o
+ \li
\image XAngleNegative.gif
\endtable
*/
@@ -295,17 +295,17 @@ inline qreal calcRoll(double Ax, double Ay, double Az)
Accuracy 5.5 will notify the client application about an rotation change only if the rotation angle over the X and / or Y axis was changed by 5.5 or more degrees clockwise or anti-clockwise.
\table
- \header \o Rotation \o notify application \o reason
- \row \o 0.2424 \o no \o
- \row \o 4.34234 \o no \o
- \row \o 5.23423 \o no \o
- \row \o 6.34324 \o yes \o because 6.34324 >= 5.5
- \row \o 7.43264 \o no \o
- \row \o 8.24504 \o no \o
- \row \o 9.34653 \o no \o
- \row \o 10.23476 \o no \o
- \row \o 11.43565 \o no \o
- \row \o 12.45645 \o yes \o because 12.45645 - 6.34324 = 6.11321 >= 5.5
+ \header \li Rotation \li notify application \li reason
+ \row \li 0.2424 \li no \li
+ \row \li 4.34234 \li no \li
+ \row \li 5.23423 \li no \li
+ \row \li 6.34324 \li yes \li because 6.34324 >= 5.5
+ \row \li 7.43264 \li no \li
+ \row \li 8.24504 \li no \li
+ \row \li 9.34653 \li no \li
+ \row \li 10.23476 \li no \li
+ \row \li 11.43565 \li no \li
+ \row \li 12.45645 \li yes \li because 12.45645 - 6.34324 = 6.11321 >= 5.5
\endtable
*/
/*!
diff --git a/src/sensors/gestures/qsensorgesture.cpp b/src/sensors/gestures/qsensorgesture.cpp
index 16f0b227..e0ed1b82 100644
--- a/src/sensors/gestures/qsensorgesture.cpp
+++ b/src/sensors/gestures/qsensorgesture.cpp
@@ -60,7 +60,7 @@
have their own specific signals, and may be discovered through
QSensorGesture::gestureSignals().
- \bold {Note that QSensorGesture uses a custom meta-object in order to provide
+ \b {Note that QSensorGesture uses a custom meta-object in order to provide
recognizer-specific signals. This means it is not possible to sub-class
QSensorGesture and use Q_OBJECT. Also qobject_cast<QSensorGesture*>(ptr) will
not work.}
diff --git a/src/sensors/qrotationsensor.cpp b/src/sensors/qrotationsensor.cpp
index 9d3b8d42..b2d65e3f 100644
--- a/src/sensors/qrotationsensor.cpp
+++ b/src/sensors/qrotationsensor.cpp
@@ -66,11 +66,11 @@ IMPLEMENT_READING(QRotationReading)
The three angles are applied to the device in the following order.
\list
- \o Right-handed rotation z (-180, 180]. Starting from the y-axis and
+ \li Right-handed rotation z (-180, 180]. Starting from the y-axis and
incrementing in the counter-clockwise direction.
- \o Right-handed rotation x [-90, 90]. Starting from the new
+ \li Right-handed rotation x [-90, 90]. Starting from the new
(once-rotated) y-axis and incrementing towards the z-axis.
- \o Right-handed rotation y (-180, 180]. Starting from the new
+ \li Right-handed rotation y (-180, 180]. Starting from the new
(twice-rotated) z-axis and incrementing towards the x-axis.
\endlist
diff --git a/src/sensors/qsensor.cpp b/src/sensors/qsensor.cpp
index 8c9a79f4..8d670bb7 100644
--- a/src/sensors/qsensor.cpp
+++ b/src/sensors/qsensor.cpp
@@ -159,11 +159,11 @@ static int qoutputrangelist_id = qRegisterMetaType<qoutputrangelist>("qoutputran
The life cycle of a sensor is typically:
\list
- \o Create a sub-class of QSensor on the stack or heap.
- \o Setup as required by the application.
- \o Start receiving values.
- \o Sensor data is used by the application.
- \o Stop receiving values.
+ \li Create a sub-class of QSensor on the stack or heap.
+ \li Setup as required by the application.
+ \li Start receiving values.
+ \li Sensor data is used by the application.
+ \li Stop receiving values.
\endlist
The sensor data is delivered via QSensorReading and its sub-classes.
@@ -848,7 +848,7 @@ QSensorReading::~QSensorReading()
Note that sensor timestamps from different sensors may not be directly
comparable (as they may choose different fixed points for their reference).
- \bold{Note that some platforms do not deliver timestamps correctly}.
+ \b{Note that some platforms do not deliver timestamps correctly}.
Applications should be prepared for occasional issues that cause timestamps to jump
backwards.
*/
diff --git a/src/sensors/qtapsensor.cpp b/src/sensors/qtapsensor.cpp
index 5cf712b1..8d57b8e9 100644
--- a/src/sensors/qtapsensor.cpp
+++ b/src/sensors/qtapsensor.cpp
@@ -149,8 +149,8 @@ void QTapReading::setTapDirection(QTapReading::TapDirection tapDirection)
\brief a value indicating if there was a single or double tap.
\list
- \o true - double tap
- \o false - single tap
+ \li true - double tap
+ \li false - single tap
\endlist
\sa {QTapReading Units}
*/