summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2019-03-19 13:42:57 +0100
committerNico Vertriest <nico.vertriest@qt.io>2019-04-30 08:25:13 +0000
commit299bbcdb59198910188ebe1abbae1d9868d8ae6d (patch)
tree9087242eeeba484a28f304e11d348c9217777187
parent5755e89a9de6c60ac574759bc820a7b915b9ee62 (diff)
Doc: Fix qdoc errors
Change-Id: I989cc21bdbbd56c3b14b934b3256bda3a01a6764 Reviewed-by: Lorn Potter <lorn.potter@gmail.com>
-rw-r--r--src/imports/sensors/qmlsensor.cpp4
-rw-r--r--src/imports/sensors/qmlsensorgesture.cpp2
-rw-r--r--src/sensors/gestures/qsensorgesturerecognizer.cpp2
3 files changed, 5 insertions, 3 deletions
diff --git a/src/imports/sensors/qmlsensor.cpp b/src/imports/sensors/qmlsensor.cpp
index 84eea6f7..0389af4a 100644
--- a/src/imports/sensors/qmlsensor.cpp
+++ b/src/imports/sensors/qmlsensor.cpp
@@ -399,7 +399,8 @@ void QmlSensor::setBufferSize(int bufferSize)
/*!
\qmlmethod bool Sensor::start()
- Start retrieving values from the sensor. Returns true if the sensor was started, false otherwise.
+ Start retrieving values from the sensor. Returns true if the sensor
+ was started, false otherwise.
Please see QSensor::start() for information.
*/
@@ -413,6 +414,7 @@ bool QmlSensor::start()
/*!
\qmlmethod bool Sensor::stop()
Stop retrieving values from the sensor.
+ Returns true if the sensor was stopped, false otherwise.
Please see QSensor::stop() for information.
*/
diff --git a/src/imports/sensors/qmlsensorgesture.cpp b/src/imports/sensors/qmlsensorgesture.cpp
index d9a51873..2e7f104c 100644
--- a/src/imports/sensors/qmlsensorgesture.cpp
+++ b/src/imports/sensors/qmlsensorgesture.cpp
@@ -211,7 +211,7 @@ void QmlSensorGesture::setEnabled(bool value)
/*!
\qmlsignal SensorGesture::detected(string gesture)
This signal is emitted whenever a gesture is detected.
- The gesture parameter contains the gesture that was detected.
+ The \a gesture parameter contains the gesture that was detected.
The corresponding handler is \c onDetected.
*/
diff --git a/src/sensors/gestures/qsensorgesturerecognizer.cpp b/src/sensors/gestures/qsensorgesturerecognizer.cpp
index baf414e1..9254da28 100644
--- a/src/sensors/gestures/qsensorgesturerecognizer.cpp
+++ b/src/sensors/gestures/qsensorgesturerecognizer.cpp
@@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn QSensorGestureRecognizer::detected(const QString &gestureId)
- Signals when the \a gestureId gesture has been recognized.
+ Signals when the gesture with id \a &gestureId been recognized.
*/
class QSensorGestureRecognizerPrivate