diff options
author | Lorn Potter <lorn.potter@nokia.com> | 2012-03-29 11:09:41 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-29 05:41:37 +0200 |
commit | 6c06a5536ad4dfe72423915c9bf99cd25a6c9b93 (patch) | |
tree | b15763bbd2784ee223e7eb5dbf7faae95d7413c0 /src/imports/sensors2/qsensor2gesture.cpp | |
parent | 2646629ea49cf808220ef54c77df613cc9fea474 (diff) |
fix up documentation according to the doc guys.
Change-Id: I417e3c57e986f9364f25d5a0e742bd31833de283
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Reviewed-by: Lorn Potter <lorn.potter@nokia.com>
Diffstat (limited to 'src/imports/sensors2/qsensor2gesture.cpp')
-rw-r--r-- | src/imports/sensors2/qsensor2gesture.cpp | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/src/imports/sensors2/qsensor2gesture.cpp b/src/imports/sensors2/qsensor2gesture.cpp index ef17c3f9..14690f35 100644 --- a/src/imports/sensors2/qsensor2gesture.cpp +++ b/src/imports/sensors2/qsensor2gesture.cpp @@ -51,11 +51,17 @@ QT_BEGIN_NAMESPACE \qmlclass SensorGesture QSensor2Gesture \inqmlmodule QtSensors 5 \since QtSensors 5.0 - \brief The SensorGesture element provides notification when sensor gestures are triggered. + \brief Provides notifications when sensor-based gestures are detected. + + This element provides notification when sensor gestures are triggered. This element is part of the \b{QtSensors 5} module. - The following QML code creates a "shake" and "template" SensorGesture QML element. + The following QML code creates a "shake" and "template" SensorGesture QML element, and + displays the detected gesture in a text element. + + QtSensors.shake gesture is available with the Qt Sensors API, but the QtSensors.SecondCounter + sensor gesture is provided as example code for the \l {SensorGesture QML Element example} \qml Item { @@ -76,8 +82,9 @@ QT_BEGIN_NAMESPACE } \endqml -A list of currently supported sensor gestures and their descriptions can be found here: -\l {Qt Sensor Gestures} + \l {Qt Sensor Gestures} contains a list of currently supported sensor gestures and their + descriptions. + */ QSensor2Gesture::QSensor2Gesture(QObject* parent) @@ -125,11 +132,11 @@ QStringList QSensor2Gesture::availableGestures() } /*! - \qmlproperty string QtSensors5::SensorGesture::gestures - Set this property to the gestures the application is interested in detecting. - The properties validGestures and invalidGestures will be set as appropriate immediately. - The list of available gestures can be found in the availableGestures property. + \qmlproperty stringlist QtSensors5::SensorGesture::gestures + Set this property to a list of the gestures that the application is interested in detecting. This property cannot be changed while the element is enabled. + + The properties validGestures and invalidGestures will be set as appropriate immediately. To determine all available getures on the system please use the \l {QtSensors5::SensorGesture::availableGestures} {availableGestures} property. @@ -181,6 +188,7 @@ QStringList QSensor2Gesture::invalidGestures() const /*! \qmlproperty bool QtSensors5::SensorGesture::enabled This property can be used to activate or deactivate the sensor gesture. + Default value is false; \sa {QtSensors5::SensorGesture::detected} {detected} */ bool QSensor2Gesture::enabled() const |