summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src/qtsensors5.qdoc
diff options
context:
space:
mode:
authorGeir Vattekar <geir.vattekar@digia.com>2012-10-04 13:48:23 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-10-12 15:16:15 +0200
commit9d4d08421acb628e0115b140e54656fc779d13db (patch)
treeeb87c8fbbe0722f70fa536227fa7a311febdea81 /src/sensors/doc/src/qtsensors5.qdoc
parent8f624bb5d19edb47fc4803a5eb0d6343de5bbae9 (diff)
Doc: Modularized the Qt Sensor Docs
Change-Id: Ie8636ec443f43b1f238342e0f6f7d321e13dce09 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/sensors/doc/src/qtsensors5.qdoc')
-rw-r--r--src/sensors/doc/src/qtsensors5.qdoc78
1 files changed, 78 insertions, 0 deletions
diff --git a/src/sensors/doc/src/qtsensors5.qdoc b/src/sensors/doc/src/qtsensors5.qdoc
new file mode 100644
index 00000000..71b62dae
--- /dev/null
+++ b/src/sensors/doc/src/qtsensors5.qdoc
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+
+/*!
+ \module QtSensors
+ \title Qt Sensors C++ Classes
+ \ingroup modules
+
+ \brief The QtSensors module provides classes for reading sensor data.
+
+ Mobile devices contains sensor hardware that allow detecting changes in various physical
+ properties of the device itself or its immediate environment. Examples of device properties
+ include the angle at which the device is held, whereas environmental properties include for
+ example the current level of ambient light.
+*/
+
+/*!
+ \qmlmodule QtSensors 5
+ \title Qt Sensors QML Types
+ \ingroup qmlmodules
+
+ \brief The QtSensors QML module provides types for reading sensor data.
+
+ \section1 QML Module API
+
+ If the module is imported into a namespace, some additional methods become available.
+
+ \code
+ import QtSensors 5.0 as Sensors
+ ...
+ Component.onCompleted: {
+ var types = Sensors.sensorTypes();
+ console.log(types.join(", "));
+ }
+ \endcode
+
+ The documentation for the module API can be found in SensorGlobal.
+
+ \section1 QML Sensor types
+
+ These types represent specific types of sensors.
+
+ Note that most properties come from the abstract \l{QtSensors::Sensor}{Sensor} element.
+
+ \annotatedlist qml-sensors_type
+
+ \section1 QML Reading types
+
+ The data from a sensor comes through a reading class.
+
+ \annotatedlist qml-sensors_reading
+*/
+