Add platform-specific documentation.

Add a compatibility map that shows which sensors are supported by the
various backends.

Also document the generic backend.

Change-Id: I3f15905e08c2f6feed60163e6a4356964a31f024
Reviewed-by: Lorn Potter <lorn.potter@nokia.com>

3 files changed, 206 insertions, 0 deletions

diff --git a/doc/src/compatmap.qdoc b/doc/src/compatmap.qdoc
new file mode 100644
index 00000000..d85bb6ca
--- /dev/null
+++ b/doc/src/compatmap.qdoc
@@ -0,0 +1,142 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Research In Motion
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page compatmap.html
+    \title Compatibility Map
+    \brief Overview of supported sensors for each platform
+
+    \raw HTML
+
+    <table cellpadding="2" cellspacing="1" border="1" width="90%">
+    <tbody>
+    <tr>
+        <td>Color</td>
+        <td>Explanation</td>
+    </tr>
+    <tr>
+        <td bgcolor="green"></td>
+        <td>The feature is fully supported.</td>
+    </tr>
+    <tr>
+        <td bgcolor="gray"></td>
+        <td>The feature is not supported.</td>
+    </tr>
+    </tbody>
+    </table>
+
+    <table align="center" cellpadding="2" cellspacing="1" border="1" rules="all" width="90%">
+    <tbody>
+    <tr>
+    <td><b>Feature</b></td>
+    <td><b>Blackberry</b></td>
+    <td><b>Linux</b></td>
+    <td><b>Generic</b></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Accelerometer</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Ambient Light Sensor</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="green"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Compass</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Gyroscope</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">IR Proximity Sensor</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Light Sensor</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Magnetometer</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Orientation Sensor</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="green"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Proximity Sensor</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Rotation Sensor</td>
+    <td bgcolor="green"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="green"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Tap Sensor</td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    </tr>
+    <tr>
+    <td nowrap="nowrap">Sensor Gestures</td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="gray"></td>
+    <td bgcolor="green">1)</td>
+    </tr>
+    </table>
+
+    \endraw
+
+    1) Support depends on the underlying platform
+
+    In addition to the table above, each sensor type might support specific features. For example
+    a magnetometer might support returning geo values. See QSensor::isFeatureSupported() for
+    additional details.
+*/
+
diff --git a/doc/src/genericbackend.qdoc b/doc/src/genericbackend.qdoc
new file mode 100644
index 00000000..02534e22
--- /dev/null
+++ b/doc/src/genericbackend.qdoc
@@ -0,0 +1,55 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Research In Motion
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page genericbackend.html
+    \title Generic Backend
+    \brief Information about the generic sensor backend
+
+    The generic sensor backend provides emulation of some of the sensors that are not supported on the
+    platform.
+    For example, on a platform without a rotation sensor but with an accelerometer, the accelerometer
+    is used to calculate the rotation, thus providing an emulated rotation sensor.
+
+    The following generic sensors are supported:
+    \table
+    \header
+        \li Emulated Sensor
+        \li Source Sensor
+    \row
+        \li Ambient Light Sensor
+        \li Light Sensor
+    \row
+        \li Orientation Sensor
+        \li Accelerometer
+    \row
+        \li Rotation Sensor
+        \li Accelerometer
+    \endtable
+    If a platform doesn't support the source sensor, then the sensor can not be emulated.
+*/
+
diff --git a/doc/src/qtsensors.qdoc b/doc/src/qtsensors.qdoc
index cc10651c..c9ca41b8 100644
--- a/doc/src/qtsensors.qdoc
+++ b/doc/src/qtsensors.qdoc
@@ -99,5 +99,14 @@
             \li Information about Qt SensorGestures use in the Emulator.
     \endtable
 
+    \section1 Platform-specific Information
+    \table
+        \row
+            \li \l {Compatibility Map}{Compatibility Map}
+            \li Compatibility map of all supported platforms.
+        \row
+            \li \l {Generic Backend}{Generic Backend}
+            \li Information about the generic sensor backend.
+    \endtable
 */