summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src/qtsensors5.qdoc
diff options
context:
space:
mode:
authorJuha Vuolle <juha.vuolle@insta.fi>2021-06-18 14:39:03 +0300
committerJuha Vuolle <juha.vuolle@insta.fi>2021-06-29 11:15:56 +0300
commit175a5ab34240c723ad2c2a2d60ad38a01ed6d218 (patch)
tree70d2f113e5eb29b2e67e323be1d824ec1615069a /src/sensors/doc/src/qtsensors5.qdoc
parent88e7d815e771f4c494ee099a9cbe8f4125bf1820 (diff)
QtSensors Qt6 documentation base update
The QtSensors module shall be released in 6.2 for the first time in Qt 6 series. This commit updates the basic things of the documentation accordingly. Documentation for sensor support, platform support, and examples shall be updated with followup commits. [ChangeLog][sensorfw] sensorfw removed from docs for now Pick-to: 6.2 Task-number: QTBUG-92512 Change-Id: I7c5e447766109bf9da8ab3cc56fe22ec42dbd875 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Lorn Potter <lorn.potter@gmail.com>
Diffstat (limited to 'src/sensors/doc/src/qtsensors5.qdoc')
-rw-r--r--src/sensors/doc/src/qtsensors5.qdoc80
1 files changed, 0 insertions, 80 deletions
diff --git a/src/sensors/doc/src/qtsensors5.qdoc b/src/sensors/doc/src/qtsensors5.qdoc
deleted file mode 100644
index 403f3282..00000000
--- a/src/sensors/doc/src/qtsensors5.qdoc
+++ /dev/null
@@ -1,80 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2017 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** 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 The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-
-/*!
- \module QtSensors
- \title Qt Sensors C++ Classes
- \ingroup modules
- \qtvariable sensors
-
- \brief Provides classes for reading sensor data.
-
- Mobile devices contain 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.\QtMinorVersion
- \title Qt Sensors QML Types
- \ingroup qmlmodules
-
- \brief Provides types for reading sensor data.
-
- \section1 QML Module API
-
- If the module is imported into a namespace, some additional methods become available.
-
- \qml \QtMinorVersion
- import QtSensors 5.\1
- // ...
- Component.onCompleted: {
- var types = QmlSensors.sensorTypes();
- console.log(types.join(", "));
- }
- \endqml
-
- The documentation for the module API can be found in QmlSensors.
-
- \section1 QML Sensor Types
-
- These types represent specific types of sensors.
-
- Note that most properties come from the abstract \l{Sensor}{Sensor} element.
-
- \annotatedlist qml-sensors_type
-
- \section1 QML Reading Types
-
- The data from a sensor comes via a reading class.
-
- \annotatedlist qml-sensors_reading
-
- \section1 All QML Types
-*/