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/qtsensors-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/qtsensors-cpp.qdoc')
| -rw-r--r-- | src/sensors/doc/src/qtsensors-cpp.qdoc | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/sensors/doc/src/qtsensors-cpp.qdoc b/src/sensors/doc/src/qtsensors-cpp.qdoc index 5157ddad..583469ec 100644 --- a/src/sensors/doc/src/qtsensors-cpp.qdoc +++ b/src/sensors/doc/src/qtsensors-cpp.qdoc @@ -28,22 +28,22 @@ /*! \page qtsensors-cpp.html \title Qt Sensors C++ Overview -\brief Information about the Qt Sensors C++ API +\brief Explains how to use the Qt Sensors C++ API. \tableofcontents \section1 Sensor Types -On a device there can be many types of sensors. Not all of the types that the Qt Sensors API -supports may be available. There may also be types available that are not defined in the -Qt Sensors API. The types of sensors available on a device is found using the -\l QSensor::sensorTypes() function. +On a device there can be many types of sensors. Not all of the types that the Qt +Sensors API supports may be available. There may also be types available that +are not defined in the Qt Sensors API. The types of sensors available on a device +is found using the \l QSensor::sensorTypes() function. For a list of built-in sensor types, see the \l{Sensor Classes} section below. \section1 Common Conventions -Unless otherwise specified, Qt Sensors uses the +Unless specified otherwise, Qt Sensors uses the \l{http://en.wikipedia.org/wiki/Cartesian_coordinate_system}{Right Hand Cartesian coordinate system}. \image sensors-coordinates.jpg @@ -56,12 +56,12 @@ Where rotation around an axis is used, the rotation shall be expressed as a Righ \image sensors-coordinates3.jpg -In general, sensor data is oriented relative to \l QPlatformScreen::nativeOrientation, i.e -to the top of the device when the device is held in its natural orientation (normally -when the device logo appears the right side up). If values are to be displayed on -the screen the values may need to be transformed so that they match the user interface orientation. A sensor -may define its data as being oriented to the UI. This will be noted in the documentation for the -sensor. +In general, sensor data is oriented relative to \l QPlatformScreen::nativeOrientation, +that is to the top of the device when the device is held in its natural orientation +(normally when the device logo appears the right side up). If values are to be +displayed on the screen, the values may need to be transformed so that they match +the user interface orientation. A sensor may define its data as being oriented +to the UI. This will be noted in the documentation for the sensor. \image sensors-sides2.jpg |