Doc: Add DocBook equivalent for custom table

QDoc provides a "\raw" command that allows a user to inject
format-specific code that complements the code that QDoc generates.

The "\raw" command expect the user to provide a "format" argument to
ensure that the provided code is generated only for the format that is
written for.

Due to a bug in QDoc DocBook generation, the DocBook documentation was
generating, sometimes incorrectly, "\raw" commands intended for the HTML
format.

The Qt Sensors documentation uses the "\raw HTML" commands to
provide some custom-colored table.

Due to the aforementioned bug, QDoc was generating some equivalent code
for DocBook, albeit no user-provided DocBook equivalent existed.

As the bug is now being fixed, the DocBook documentation for Sensors
will lose the custom-colored table in its output.

To preserve the custom-colored table when generating the DocBook
documentation, an equivalent "\raw DocBook" command is now provided.

Change-Id: I249dec021719d1f7823e813b67e4de5ce93b49a6
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

1 files changed, 129 insertions, 0 deletions

diff --git a/src/sensors/doc/src/compatmap.qdoc b/src/sensors/doc/src/compatmap.qdoc
index 1f90d1ee..41f91a73 100644
--- a/src/sensors/doc/src/compatmap.qdoc
+++ b/src/sensors/doc/src/compatmap.qdoc
@@ -136,6 +136,135 @@
 
     \endraw
 
+    \raw DocBook
+<db:informaltable cellpadding="2" cellspacing="1" border="1" width="90%">
+    <db:tbody>
+    <db:tr>
+        <db:td>Color</db:td>
+        <db:td>Explanation</db:td>
+    </db:tr>
+    <db:tr>
+        <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+        <db:td>The sensor is supported.</db:td>
+    </db:tr>
+    <db:tr>
+        <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+        <db:td>The sensor is not supported.</db:td>
+    </db:tr>
+    </db:tbody>
+    </db:informaltable>
+
+
+    <db:informaltable cellpadding="2" cellspacing="1" border="1" rules="all" width="90%">
+    <db:tbody>
+    <db:tr>
+    <db:td><db:emphasis role="bold">Feature</db:emphasis></db:td>
+    <db:td><db:emphasis role="bold">Android</db:emphasis></db:td>
+    <db:td><db:emphasis role="bold">Linux</db:emphasis></db:td>
+    <db:td><db:emphasis role="bold">iOS</db:emphasis></db:td>
+    <db:td><db:emphasis role="bold">Windows</db:emphasis></db:td>
+    <db:td><db:emphasis role="bold">Generic</db:emphasis></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Accelerometer</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Ambient Light Sensor</db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Ambient Temperature Sensor</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Compass</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Gyroscope</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Light Sensor</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Magnetometer</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Orientation Sensor</db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Pressure Sensor</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Proximity Sensor</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Rotation Sensor</db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    </db:tr>
+    <db:tr>
+    <db:td>Tilt Sensor</db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    <db:td  class="bgcolor-gray" ><?dbhtml bgcolor="gray" ?><?dbfo bgcolor="gray" ?></db:td>
+    <db:td  class="bgcolor-green" ><?dbhtml bgcolor="green" ?><?dbfo bgcolor="green" ?></db:td>
+    </db:tr>
+    </db:tbody>
+    </db:informaltable>
+    \endraw
+
     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.