diff options
author | Thomas McGuire <thomas.mcguire.qnx@kdab.com> | 2012-07-25 17:24:31 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-07-26 01:35:12 +0200 |
commit | e581a0174cc77351aa4e6813f1fe6c19cf82a135 (patch) | |
tree | 534291744297642f239d924c0b87ea07cfe353eb /doc/src/genericbackend.qdoc | |
parent | c7fd6aeefc60a9ac81b0e4565f2bdea8c5c66512 (diff) |
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>
Diffstat (limited to 'doc/src/genericbackend.qdoc')
-rw-r--r-- | doc/src/genericbackend.qdoc | 55 |
1 files changed, 55 insertions, 0 deletions
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. +*/ + |