diff options
author | Geir Vattekar <geir.vattekar@digia.com> | 2012-10-04 13:48:23 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-10-12 15:16:15 +0200 |
commit | 9d4d08421acb628e0115b140e54656fc779d13db (patch) | |
tree | eb87c8fbbe0722f70fa536227fa7a311febdea81 /src/sensors/doc/src/qtsensors.qdoc | |
parent | 8f624bb5d19edb47fc4803a5eb0d6343de5bbae9 (diff) | |
download | qtsensors-9d4d08421acb628e0115b140e54656fc779d13db.tar.gz |
Doc: Modularized the Qt Sensor Docs
Change-Id: Ie8636ec443f43b1f238342e0f6f7d321e13dce09
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/sensors/doc/src/qtsensors.qdoc')
-rw-r--r-- | src/sensors/doc/src/qtsensors.qdoc | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/src/sensors/doc/src/qtsensors.qdoc b/src/sensors/doc/src/qtsensors.qdoc new file mode 100644 index 0000000..6128673 --- /dev/null +++ b/src/sensors/doc/src/qtsensors.qdoc @@ -0,0 +1,117 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** 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 qtsensors-index.html + \title Qt Sensors + \brief The Qt Sensors API provides access to sensors via QML and C++ interfaces. + \ingroup technology-apis + + The Qt Sensors API provides access to sensor hardware via QML and C++ interfaces. + The Qt Sensors API also provides motion gesture recognition API for devices. + + \section1 Information for Application Writers + + Applications can access Qt Sensors using QML or C++. + + \table + \row + \li \l {Qt Sensors QML Types}{QML Types} + \li Information about the Qt Sensors QML API + \row + \li \l {Qt Sensors C++ Classes}{C++ Classes} + \li Information about the Qt Sensors C++ API + \row + \li \l{Qt Sensors C++ Overview} + \li High-level information on how to use the C++ API. + \row + \li \l {Sensor Gestures C++ Overview} + \li High-level information specific to sensor gestures. + \row + \li \l {Qt Sensors Examples}{Examples} + \li Examples demonstrating use of the Qt Sensors APIs + \endtable + + \section1 Information for Backend Implementors + + \table + \row + \li \l {Qt Sensors Backend}{Backend} + \li Information about the Qt Sensors back end + \row + \li \l {Qt Sensors - Grue Sensor Example} + \li The Qt Sensors - Grue Sensor Example demonstrates creation of a sensor backend + \endtable + + \section1 Compatibility with QtMobility Sensors API + + Qt Sensors 5.0 (the initial release) is generally expected to be source compatible + with QtMobility Sensors 1.2. + + \table + \row + \li \l {Porting Applications from QtMobility Sensors to Qt Sensors}{Porting Guide} + \li Information about the steps needed to port applications to the Qt Sensors API. + \endtable + + \omit + \section1 Information for Qt SensorGestures API + + Qt SensorGestures provides a motion gesture recognition API for devices. + + \table + \row + \li \l {SensorGesture}{QML API} + \li Information about the Qt SensorGestures QML API + \row + \li \l {QtSensorGestures C++ API}{C++ API} + \li Information about the Qt SensorGestures C++ API + \endtable + + \section1 Information for Qt SensorGestures Recognizer Plugin Implementors. + + \table + \row + \li \l {QtSensorGestures Plugins}{Plugins} + \li Information about the Qt SensorGestures recognizer plugins. + \row + \li \l {QtSensorGestures Emulator}{Emulator} + \li Information about Qt SensorGestures use in the Emulator. + \endtable + \endomit + + \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 +*/ + |