summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src/genericbackend.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/sensors/doc/src/genericbackend.qdoc')
-rw-r--r--src/sensors/doc/src/genericbackend.qdoc55
1 files changed, 55 insertions, 0 deletions
diff --git a/src/sensors/doc/src/genericbackend.qdoc b/src/sensors/doc/src/genericbackend.qdoc
new file mode 100644
index 00000000..689b4124
--- /dev/null
+++ b/src/sensors/doc/src/genericbackend.qdoc
@@ -0,0 +1,55 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Research In Motion
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $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.
+*/
+