diff options
Diffstat (limited to 'src/doc/src')
| -rw-r--r-- | src/doc/src/qtdeviceutilities-index.qdoc | 39 | ||||
| -rw-r--r-- | src/doc/src/qtdeviceutilities-module-cpp.qdoc | 32 | ||||
| -rw-r--r-- | src/doc/src/qtdeviceutilities-module-qml.qdoc | 37 |
3 files changed, 60 insertions, 48 deletions
diff --git a/src/doc/src/qtdeviceutilities-index.qdoc b/src/doc/src/qtdeviceutilities-index.qdoc index ed07853..53627da 100644 --- a/src/doc/src/qtdeviceutilities-index.qdoc +++ b/src/doc/src/qtdeviceutilities-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -28,15 +28,35 @@ /*! \page qtdeviceutilities-index.html \maintitle - \brief Provides functionality that is useful for embedded applications. + \brief Provides functionality for controlling settings in embedded applications. + + \QtDU provides functionality that is useful for controlling settings in embedded + applications. The functionality in \QtDU is divided into the following C++ modules: + + \annotatedlist qtdevice-utilities-cpp-modules + + \QtDU provides the following QML modules: + + \annotatedlist qtdevice-utilities-qml-modules \section1 Getting Started To include the definitions of the module's classes, use the following - directive: + directives: \code - #include <QDeviceUtilities> + #include <QtBluetoothSettings> + #include <QtDisplaySettings> + #include <QtLocalDevice> + #include <QtLocaleSettings> + #include <QtNetworkSettings> + #include <QtTimeDateSettings> + \endcode + + To link against the modules, add this line to your qmake .pro file: + + \badcode + QT += bluetoothsettings displaysettings localdevice localesettings networksettings timedatesettings \endcode To import the QML types into your application, use the following import @@ -52,12 +72,6 @@ import QtDeviceUtilities.TimeDateSettings 1.0 \endcode - To link against the module, add this line to your qmake .pro file: - - \code - QT += deviceutilities - \endcode - \section1 Examples \list @@ -67,7 +81,8 @@ \section1 Reference \list - \li \l {Qt Device Utilities C++ Classes} {C++ Classes and Namespaces} - \li \l {Qt Device Utilities QML Types} {QML Types} + \li \l {Qt Device Utilities C++ Classes} + \li \l {Qt Device Utilities QML Types} \endlist */ + diff --git a/src/doc/src/qtdeviceutilities-module-cpp.qdoc b/src/doc/src/qtdeviceutilities-module-cpp.qdoc index caa9346..a6eef84 100644 --- a/src/doc/src/qtdeviceutilities-module-cpp.qdoc +++ b/src/doc/src/qtdeviceutilities-module-cpp.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -26,23 +26,31 @@ ****************************************************************************/ /*! - \module QtDeviceUtilities + \page qtdeviceutilities-cpp-classes.html \title Qt Device Utilities C++ Classes \brief Provides classes that are useful for embedded applications. \ingroup modules - \qtvariable deviceutilities + \QtDU modules provide classes that are useful for embedded applications. - To include the definitions of the module's classes, use the following - directive: + \section1 Classes - \badcode - #include <QtDeviceUtilities> - \endcode + \section2 Qt Bluetooth Settings Module + \generatelist {classesbymodule QtBluetoothSettings} - To link against the module, add this line to your qmake .pro file: + \section2 Qt Display Settings Module + \generatelist {classesbymodule QtDisplaySettings} - \badcode - QT += qtdeviceutilities - \endcode + \section2 Qt Local Device Settings Module + \generatelist {classesbymodule QtLocalDeviceSettings} + + \section2 Qt Locale Settings Module + \generatelist {classesbymodule QtLocaleSettings} + + \section2 Qt Network Settings Module + \generatelist {classesbymodule QtNetworkSettings} + + \section2 Qt Time and Date Settings Module + \generatelist {classesbymodule QtTimeDateSettings} */ + diff --git a/src/doc/src/qtdeviceutilities-module-qml.qdoc b/src/doc/src/qtdeviceutilities-module-qml.qdoc index 44fc688..bd08a8a 100644 --- a/src/doc/src/qtdeviceutilities-module-qml.qdoc +++ b/src/doc/src/qtdeviceutilities-module-qml.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Device Utilities module of the Qt Toolkit. @@ -25,14 +25,13 @@ ** ****************************************************************************/ /*! - \qmlmodule QtDeviceutilities 1.0 + \page qtdeviceutilities-qml-types.html \title Qt Device Utilities QML Types \brief Provides additional modules that are useful for embedded applications. - \ingroup qmlmodules - The QML types in the modules can be imported into your application using the - following import statements in your .qml file: + The QML types in the \QtDU modules can be imported into your application using the + following import statements in your .qml file: \badcode import QtDeviceUtilities.BluetoothSettings 1.0 @@ -44,37 +43,27 @@ import QtDeviceUtilities.TimeDateSettings 1.0 \endcode - To link against the module, add this line to your qmake .pro file: - - \badcode - QT += deviceutilities - \endcode - - \section1 Modules - - \annotatedlist qtee-qmlmodules - \section1 QML Types - \section2 Bluetooth Settings + \section2 Qt Bluetooth Settings Module \generatelist qmltypesbymodule QtDeviceUtilities.BluetoothSettings - \section2 Display Settings + \section2 Qt Display Settings Module \generatelist qmltypesbymodule QtDeviceUtilities.DisplaySettings - \section2 Local Device Settings + \section2 Qt Local Device Settings Module \generatelist qmltypesbymodule QtDeviceUtilities.LocalDeviceSettings - \section2 Locale Settings + \section2 Qt Locale Settings Module \generatelist qmltypesbymodule QtDeviceUtilities.LocaleSettings - \section2 Network Settings + \section2 Qt Network Settings Module \generatelist qmltypesbymodule QtDeviceUtilities.NetworkSettings - \section2 Time and Date Settings - \generatelist qmltypesbymodule QtDeviceUtilities.TimeDateSettings - - \section2 Settings UI + \section2 Qt Settings UI Module \generatelist qmltypesbymodule QtDeviceUtilities.SettingsUI + + \section2 Qt Time and Date Settings Module + \generatelist qmltypesbymodule QtDeviceUtilities.TimeDateSettings */ |