diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2013-09-24 12:25:12 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-11-04 12:36:42 +0100 |
commit | 303fc6d4c3a7e4a15fa9e92dc5448bb8f7982509 (patch) | |
tree | fab2a186b2d3362caef9ec7a5ea519b1a7b639f6 /src/sensors/doc/src/qtsensorgestures-cpp.qdoc | |
parent | 76d4cae393305a1a87e53b88ef80a2a1a87758b7 (diff) |
Doc: review of QtSensors
Minor corrections in compatmap.qdoc
Task-number: QTBUG-32173
Change-Id: Ic4f881449e65c2d6889f0e217d251214997a8a56
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/sensors/doc/src/qtsensorgestures-cpp.qdoc')
-rw-r--r-- | src/sensors/doc/src/qtsensorgestures-cpp.qdoc | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/src/sensors/doc/src/qtsensorgestures-cpp.qdoc b/src/sensors/doc/src/qtsensorgestures-cpp.qdoc index 70aa3e61..3ffbb5a7 100644 --- a/src/sensors/doc/src/qtsensorgestures-cpp.qdoc +++ b/src/sensors/doc/src/qtsensorgestures-cpp.qdoc @@ -28,22 +28,24 @@ /*! \page qtsensorgestures-cpp.html \title Sensor Gestures C++ Overview -\brief Information about the QtSensorGestures C++ API +\brief Explains how to use the QtSensorGestures C++ API \tableofcontents \section1 Using QtSensorGestures With the Sensor Gestures classes, you are able to easily utilize device gesturing using -sensors such as the accelerometer and proximity. +sensors, such as the accelerometer and proximity. A list of currently supported sensor gestures and their descriptions can be found here: \l {Qt Sensor Gestures} -Using QtSensorGestures is easy. There are two main classes you will need to use. +Using \c QtSensorGestures is easy. There are two main classes you will need to use: -QSensorGestureManager can be used for determining what sensor gestures are available, and -QSensorGesture for connecting the sensor gesture signals. +\list + \li QSensorGestureManager: can be used for determining which sensor gestures are available. + \li QSensorGesture : for connecting the sensor gesture signals. +\endlist \snippet sensorgestures/creating.cpp Receiving sensor gesture signals @@ -52,15 +54,15 @@ More information about the sensor gesture recognizers can be found in \section1 Main Classes -The primary classes that make up the QtSensorGestures API. +The primary classes that make up the QtSensorGestures API: \annotatedlist sensorgestures_main -The primary classes that make up the QtSensorGesturesRecognizers API. +The primary classes that make up the \c QtSensorGesturesRecognizers API: \annotatedlist sensorgestures_recognizer -Details of the QSensorGesturePlugins available +Details of the \c QSensorGesturePlugins available \annotatedlist sensorgesture_plugins_topics |