diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-01 07:10:16 +0100 |
---|---|---|
committer | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-15 12:28:45 +0100 |
commit | 97ecf87e6f050eba61e4278014a22db2768631be (patch) | |
tree | 064f159e7103493c8912f5803c36dd6e57e03703 /src | |
parent | 31c8e8069ba6925e1ea634e3c64f874819d5b834 (diff) |
Doc: Revise Qt Sensors module landing page
- Use new global .qdocinc snippets
- Change tables to lists
- Rearrange sections to align with defined template structure
Task-number: QTBUG-100369
Pick-to: 6.3
Change-Id: I5118af7fb82378af3cf9d5db1cb8e651f01a08d1
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/sensors/doc/src/qtsensors.qdoc | 89 |
1 files changed, 35 insertions, 54 deletions
diff --git a/src/sensors/doc/src/qtsensors.qdoc b/src/sensors/doc/src/qtsensors.qdoc index fb805d83..92c671ac 100644 --- a/src/sensors/doc/src/qtsensors.qdoc +++ b/src/sensors/doc/src/qtsensors.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2022 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -31,77 +31,58 @@ \brief Provides access to sensors via QML and C++ interfaces. \since 5.1 - The Qt Sensors API provides access to sensor hardware via QML and C++ interfaces. + The Qt Sensors module provides access to sensor hardware via QML and C++ + interfaces. - Currently the API is supported on \l{Qt for Android}{Android}, + Currently, the API is supported on \l{Qt for Android}{Android}, \l{Qt for iOS}{iOS}, and \l {Qt for Windows}{Windows (MSVC)}. - \section1 Information for Application Writers + \section1 Using the Module - Applications can access Qt Sensors using QML or C++. + \section2 QML API - To include the definitions of the module's classes, use the following directive: + \include {module-use.qdocinc} {using the qml api} {QtSensors} - \code - #include <QtSensors> - \endcode + \section2 C++ API - To import the QML types into your application, use the following import statement - in your .qml file: + \include {module-use.qdocinc} {using the c++ api} - \qml - import QtSensors - \endqml + \section3 Building with CMake - To link against the module: + \include {module-use.qdocinc} {building with cmake} {Sensors} - Using cmake: - \include qtsensors-module-use.qdocinc cmakebuild + \section3 Building with qmake - Using qmake: - \include qtsensors-module-use.qdocinc qmakebuild + \include {module-use.qdocinc} {building_with_qmake} {sensors} - Further references: + \section1 Articles and Guides - \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 {Qt Sensors Examples}{Examples} - \li Examples demonstrating the use of the Qt Sensors APIs - \endtable + \list + \li \l {Qt Sensors C++ Overview} + \li \l {Generic Backend} {Generic Backend} + \li \l {Qt Sensors Backend} + \li \l {Compatibility Map} {Compatibility Map} + \endlist - \section1 Information for Backend Implementors + \section1 Examples - \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 + \list + \li \l {Qt Sensors Examples} {Examples} + \li \l {Qt Sensors - Grue Sensor Example} + \endlist + + \section1 API Reference + + \list + \li \l {Qt Sensors QML Types} {QML Types} + \li \l {Qt Sensors C++ Classes} {C++ Classes} + \endlist \section1 Module Evolution \l{Changes to Qt Sensors} lists important changes in the module API - and functionality that were done for the Qt 6 series of Qt. - - \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 + and functionality that were made for the Qt 6 series of Qt. + + \section1 Licenses The Qt Sensors module is available under commercial licenses from \l{The Qt Company}. In addition, it is available under free software licenses: |