From fb3675ae9a5f96b7e8b50a9731a5fd126b8e6a40 Mon Sep 17 00:00:00 2001 From: Tarja Sundqvist Date: Wed, 6 Mar 2019 10:44:04 +0200 Subject: Fix the list of linked Device Utilities modules All Device Utilities modules are listed in the main page. Also All C++ classes / All QML Types pages added. Task-number: QTBUG-74231 Change-Id: Ia6b091e6d136b844c36de94f8fafa0bb7b199777 Reviewed-by: Leena Miettinen Reviewed-by: Samuli Piippo Reviewed-by: Teemu Holappa --- src/bluetoothsettings/bluetoothdevice.cpp | 26 +++++++++++++-- src/displaysettings/displaysettings.cpp | 26 +++++++++++++-- src/doc/qtdeviceutilities-project.qdocconf | 1 + src/doc/src/qtdeviceutilities-index.qdoc | 39 +++++++++++++++------- src/doc/src/qtdeviceutilities-module-cpp.qdoc | 32 +++++++++++------- src/doc/src/qtdeviceutilities-module-qml.qdoc | 37 ++++++++------------ src/imports/bluetoothsettings/plugin.cpp | 15 ++++----- src/imports/displaysettings/plugin.cpp | 15 ++++----- src/imports/localdevice/plugin.cpp | 18 +++++----- src/imports/localesettings/plugin.cpp | 13 ++++---- src/imports/networksettings/plugin.cpp | 13 ++++---- src/imports/timedatesettings/plugin.cpp | 17 +++++----- src/localdevice/qlocaldevice.cpp | 24 ++++++++++++- src/localesettings/localefiltermodel.cpp | 24 ++++++++++++- src/localesettings/localemodel.cpp | 4 +-- src/networksettings/qnetworksettings.cpp | 36 ++++++++++++++++---- .../qnetworksettingsaddressmodel.cpp | 4 +-- src/networksettings/qnetworksettingsinterface.cpp | 4 +-- .../qnetworksettingsinterfacemodel.cpp | 4 +-- src/networksettings/qnetworksettingsmanager.cpp | 4 +-- src/networksettings/qnetworksettingsservice.cpp | 4 +-- .../qnetworksettingsservicemodel.cpp | 6 ++-- src/networksettings/qnetworksettingsuseragent.cpp | 4 +-- src/settingsui/settingsuiplugin/plugin.cpp | 7 ++-- src/timedatesettings/systemtime.cpp | 24 ++++++++++++- src/timedatesettings/timezonemodel.cpp | 4 +-- 26 files changed, 274 insertions(+), 131 deletions(-) (limited to 'src') diff --git a/src/bluetoothsettings/bluetoothdevice.cpp b/src/bluetoothsettings/bluetoothdevice.cpp index 01de4bc..dda2386 100644 --- a/src/bluetoothsettings/bluetoothdevice.cpp +++ b/src/bluetoothsettings/bluetoothdevice.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -32,9 +32,31 @@ QT_BEGIN_NAMESPACE +/*! + \module QtBluetoothSettings + \qtvariable bluetoothsettings + \ingroup qtdevice-utilities-cpp-modules + \ingroup modules + \title Qt Bluetooth Settings C++ Classes + \brief Provides functionality for controlling Bluetooth settings. + + To use classes from this module, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += bluetoothsettings + \endcode +*/ + /*! \class BluetoothDevice - \inmodule QtDeviceUtilities + \inmodule QtBluetoothSettings \brief The BluetoothDevice class controls Bluetooth settings. diff --git a/src/displaysettings/displaysettings.cpp b/src/displaysettings/displaysettings.cpp index de2d416..c7c93c8 100644 --- a/src/displaysettings/displaysettings.cpp +++ b/src/displaysettings/displaysettings.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -31,9 +31,31 @@ QT_BEGIN_NAMESPACE +/*! + \module QtDisplaySettings + \qtvariable displaysettings + \ingroup qtdevice-utilities-cpp-modules + \ingroup modules + \title Qt Display Settings C++ Classes + \brief Provides access to display settings. + + To use classes from this module, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += displaysettings + \endcode +*/ + /*! \class DisplaySettings - \inmodule QtDeviceUtilities + \inmodule QtDisplaySettings \brief The DisplaySettings class specifies display settings. diff --git a/src/doc/qtdeviceutilities-project.qdocconf b/src/doc/qtdeviceutilities-project.qdocconf index 71af922..5898e49 100644 --- a/src/doc/qtdeviceutilities-project.qdocconf +++ b/src/doc/qtdeviceutilities-project.qdocconf @@ -75,6 +75,7 @@ macro.SDK = "Qt for Device Creation" macro.QAS = "Qt Automotive Suite" macro.B2QA = "\\e {Boot to Qt for embedded Android}" macro.B2QL = "\\e {Boot to Qt for embedded Linux}" +macro.QtDU = "Qt Device Utilities" # Keep Device Creation as the landing page navigation.landingpage = "Qt for Device Creation" 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 + #include + #include + #include + #include + #include + #include + \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 - \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 */ diff --git a/src/imports/bluetoothsettings/plugin.cpp b/src/imports/bluetoothsettings/plugin.cpp index 6c5fcf1..db180f7 100644 --- a/src/imports/bluetoothsettings/plugin.cpp +++ b/src/imports/bluetoothsettings/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -37,21 +37,18 @@ /*! \qmlmodule QtDeviceUtilities.BluetoothSettings 1.0 - \title Qt Device Utilities: Bluetooth Settings - \ingroup qtee-qmlmodules - \brief Provides a singleton QML type for controlling bluetooth settings. + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules + \title Qt Bluetooth Settings QML Types - Provides a singleton QML type for controlling bluetooth settings in an - embedded device. + \brief Provides a singleton QML type for controlling bluetooth settings. - Import the module as follows: + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.BluetoothSettings 1.0 \endcode - This will give you access to the singleton QML type BtDevice. - \note Some functions may not be available on all of the platforms. \section1 QML Types diff --git a/src/imports/displaysettings/plugin.cpp b/src/imports/displaysettings/plugin.cpp index 601b8e0..1fd56b0 100644 --- a/src/imports/displaysettings/plugin.cpp +++ b/src/imports/displaysettings/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -34,21 +34,18 @@ /*! \qmlmodule QtDeviceUtilities.DisplaySettings 1.0 - \title Qt Device Utilities: Display Settings - \ingroup qtee-qmlmodules - \brief Provides a singleton QML type for controlling display settings. + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules + \title Qt Display Settings QML Types - Provides a singleton QML type for controlling display settings in an - embedded device. + \brief Provides a singleton QML type for controlling display settings. - Import the module as follows: + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.DisplaySettings 1.0 \endcode - This will give you access to the singleton QML type DisplaySettings. - \note Some functions may not be available on all of the platforms. \section1 QML Types diff --git a/src/imports/localdevice/plugin.cpp b/src/imports/localdevice/plugin.cpp index 506c6f6..8a59a27 100644 --- a/src/imports/localdevice/plugin.cpp +++ b/src/imports/localdevice/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -31,21 +31,21 @@ /*! \qmlmodule QtDeviceUtilities.LocalDeviceSettings 1.0 - \title Qt Device Utilities: Local Device Settings - \ingroup qtee-qmlmodules - \brief A collection of local device related utility functions. + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules + \title Qt Local Device Settings QML Types - Provides utility functions for controlling an embedded - device, such as device shutdown/reboot. + \brief Provides a collection of local device related utility functions. - Import the module as follows: + Qt Local Device Settings QML modules provides utility functions for controlling + an embedded device, such as device shutdown and reboot. + + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.LocalDeviceSettings 1.0 \endcode - This will give you access to the singleton QML type LocalDevice. - \note Some functions may not be available on all of the platforms. \section1 QML Types diff --git a/src/imports/localesettings/plugin.cpp b/src/imports/localesettings/plugin.cpp index deaad2b..573e5bc 100644 --- a/src/imports/localesettings/plugin.cpp +++ b/src/imports/localesettings/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -37,15 +37,16 @@ /*! \qmlmodule QtDeviceUtilities.LocaleSettings 1.0 + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules + \title Qt Locale Settings QML Types - \title Qt Device Utilities: Locale Settings - \ingroup qtee-qmlmodules \brief Provides singleton QML types for controlling locale settings. - Provides singleton QML types for controlling locale settings in an - embedded device. + Qt Local Device Settings QML module provides singleton QML types for + controlling locale settings in an embedded device. - Import the module as follows: + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.LocaleSettings 1.0 diff --git a/src/imports/networksettings/plugin.cpp b/src/imports/networksettings/plugin.cpp index 6900550..56bece7 100644 --- a/src/imports/networksettings/plugin.cpp +++ b/src/imports/networksettings/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -41,15 +41,16 @@ /*! \qmlmodule QtDeviceUtilities.NetworkSettings 1.0 + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules + \title Qt Network Settings QML Types - \title Qt Device Utilities: Network Settings - \ingroup qtee-qmlmodules \brief Provides singleton QML types for controlling network settings. - Provides singleton QML types for controlling network settings in an - embedded device. + Qt Network Settings QML module provides singleton QML types for controlling + network settings in an embedded device. - Import the module as follows: + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.NetworkSettings 1.0 diff --git a/src/imports/timedatesettings/plugin.cpp b/src/imports/timedatesettings/plugin.cpp index 0ddfed4..70a766c 100644 --- a/src/imports/timedatesettings/plugin.cpp +++ b/src/imports/timedatesettings/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -34,18 +34,19 @@ #include #include "timezonefiltermodel.h" + /*! \qmlmodule QtDeviceUtilities.TimeDateSettings 1.0 + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules + \title Qt Time and Date Settings QML Types - \title Qt Device Utilities: Time and Date Settings - \ingroup qtee-qmlmodules - \brief Provides singleton QML types for controlling date and time - settings. + \brief Provides singleton QML types for controlling date and time settings. - Provides singleton QML types for controlling date and time settings - in an embedded device. + Qt Time and Date Settings QML module provides singleton QML types for controlling + date and time settings in an embedded device. - Import the module as follows: + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.TimeDateSettings 1.0 diff --git a/src/localdevice/qlocaldevice.cpp b/src/localdevice/qlocaldevice.cpp index 131539a..fc17eae 100644 --- a/src/localdevice/qlocaldevice.cpp +++ b/src/localdevice/qlocaldevice.cpp @@ -32,9 +32,31 @@ QT_BEGIN_NAMESPACE +/*! + \module QtLocalDeviceSettings + \qtvariable localdevice + \ingroup qtdevice-utilities-cpp-modules + \ingroup modules + \title QtLocalDeviceSettings C++ Classes + \brief Provides functionality for controlling a local device settings. + + To use classes from this module, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += localdevice + \endcode +*/ + /*! \class QLocalDevice - \inmodule QtDeviceUtilities + \inmodule QtLocalDeviceSettings \brief The QLocalDevice class provides utility functions for controlling an embedded device. diff --git a/src/localesettings/localefiltermodel.cpp b/src/localesettings/localefiltermodel.cpp index 3a5d892..e3eecd4 100644 --- a/src/localesettings/localefiltermodel.cpp +++ b/src/localesettings/localefiltermodel.cpp @@ -31,9 +31,31 @@ QT_BEGIN_NAMESPACE +/*! + \module QtLocaleSettings + \qtvariable localesettings + \ingroup qtdevice-utilities-cpp-modules + \ingroup modules + \title Qt Locale Settings C++ Classes + \brief Provides functionality for controlling locale settings. + + To use classes from this module, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += localesettings + \endcode +*/ + /*! \class LocaleFilterModel - \inmodule QtDeviceUtilities + \inmodule QtLocaleSettings \brief The LocaleFilterModel class provides a filtered model for the available locales. diff --git a/src/localesettings/localemodel.cpp b/src/localesettings/localemodel.cpp index cd411f3..37eb2ee 100644 --- a/src/localesettings/localemodel.cpp +++ b/src/localesettings/localemodel.cpp @@ -37,7 +37,7 @@ QT_BEGIN_NAMESPACE /*! \class LocaleItem - \inmodule QtDeviceUtilities + \inmodule QtLocaleSettings \brief The LocaleItem class represents a locale. @@ -119,7 +119,7 @@ QString LocaleItem::code() const /*! \class LocaleModel - \inmodule QtDeviceUtilities + \inmodule QtLocaleSettings \brief The LocaleModel class provides a model for the available locales. diff --git a/src/networksettings/qnetworksettings.cpp b/src/networksettings/qnetworksettings.cpp index 324959e..49f210e 100644 --- a/src/networksettings/qnetworksettings.cpp +++ b/src/networksettings/qnetworksettings.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -30,9 +30,31 @@ QT_BEGIN_NAMESPACE +/*! + \module QtNetworkSettings + \qtvariable networksettings + \ingroup qtdevice-utilities-cpp-modules + \ingroup modules + \title Qt Network Settings C++ Classes + \brief Provides functionality for controlling network settings. + + To use classes from this module, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += networksettings + \endcode +*/ + /*! \class QNetworkSettingsState - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsState class represents the network interface state. @@ -112,7 +134,7 @@ void QNetworkSettingsState::setState(const States state) { /*! \class QNetworkSettingsType - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsType class represents the network interface type. @@ -186,7 +208,7 @@ void QNetworkSettingsType::setType(const Types type) { /*! \class QNetworkSettingsIPv4 - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsIPv4 class encapsulates IPv4 network configuration. @@ -273,7 +295,7 @@ void QNetworkSettingsIPv4::setMask(const QString& mask) { /*! \class QNetworkSettingsIPv6 - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsIPv6 class encapsulates IPv6 network configuration. @@ -392,7 +414,7 @@ void QNetworkSettingsIPv6::setPrefixLength(const int& prefixLength) { /*! \class QNetworkSettingsProxy - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsProxy class encapsulates network proxy configuration. */ @@ -497,7 +519,7 @@ void QNetworkSettingsProxy::setMethod(const MethodType& method) { /*! \class QNetworkSettingsWireless - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsWireless class encapsulates the configuration for a Wifi network service. */ diff --git a/src/networksettings/qnetworksettingsaddressmodel.cpp b/src/networksettings/qnetworksettingsaddressmodel.cpp index 7872018..ab0b65f 100644 --- a/src/networksettings/qnetworksettingsaddressmodel.cpp +++ b/src/networksettings/qnetworksettingsaddressmodel.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -32,7 +32,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsAddressModel - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsAddressModel class represents a network interface address. diff --git a/src/networksettings/qnetworksettingsinterface.cpp b/src/networksettings/qnetworksettingsinterface.cpp index 7bf6ae0..d885394 100644 --- a/src/networksettings/qnetworksettingsinterface.cpp +++ b/src/networksettings/qnetworksettingsinterface.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -34,7 +34,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsInterface - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief Represents a network interface. The QNetworkSettingsInterface class represents a network interface attached diff --git a/src/networksettings/qnetworksettingsinterfacemodel.cpp b/src/networksettings/qnetworksettingsinterfacemodel.cpp index 09b96ba..d35aaf2 100644 --- a/src/networksettings/qnetworksettingsinterfacemodel.cpp +++ b/src/networksettings/qnetworksettingsinterfacemodel.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -33,7 +33,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsInterfaceModel - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsInterfaceModel class represents a network interface model. diff --git a/src/networksettings/qnetworksettingsmanager.cpp b/src/networksettings/qnetworksettingsmanager.cpp index b1cfbf8..c7c2230 100644 --- a/src/networksettings/qnetworksettingsmanager.cpp +++ b/src/networksettings/qnetworksettingsmanager.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -39,7 +39,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsManager - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsManager class manages network settings. diff --git a/src/networksettings/qnetworksettingsservice.cpp b/src/networksettings/qnetworksettingsservice.cpp index c91c4f6..150b54d 100644 --- a/src/networksettings/qnetworksettingsservice.cpp +++ b/src/networksettings/qnetworksettingsservice.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -33,7 +33,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsService - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsService class represents a network service. diff --git a/src/networksettings/qnetworksettingsservicemodel.cpp b/src/networksettings/qnetworksettingsservicemodel.cpp index 2a0a2a8..a62d415 100644 --- a/src/networksettings/qnetworksettingsservicemodel.cpp +++ b/src/networksettings/qnetworksettingsservicemodel.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -33,7 +33,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsServiceModel - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsServiceModel class represents a network service. @@ -284,7 +284,7 @@ void QNetworkSettingsServiceModel::signalStrengthChanged() /*! \class QNetworkSettingsServiceFilter - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsServiceFilter class represents a network service filter. diff --git a/src/networksettings/qnetworksettingsuseragent.cpp b/src/networksettings/qnetworksettingsuseragent.cpp index 7458682..59942bf 100644 --- a/src/networksettings/qnetworksettingsuseragent.cpp +++ b/src/networksettings/qnetworksettingsuseragent.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -33,7 +33,7 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkSettingsUserAgent - \inmodule QtDeviceUtilities + \inmodule QtNetworkSettings \brief The QNetworkSettingsUserAgent represents the user credentials for connecting to a network. diff --git a/src/settingsui/settingsuiplugin/plugin.cpp b/src/settingsui/settingsuiplugin/plugin.cpp index 504e4ed..3e9a274 100644 --- a/src/settingsui/settingsuiplugin/plugin.cpp +++ b/src/settingsui/settingsuiplugin/plugin.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -40,14 +40,15 @@ static void initResources() /*! \qmlmodule QtDeviceUtilities.SettingsUI 1.0 \title Qt Device Utilities: Settings UI - \ingroup qtee-qmlmodules + \ingroup qtdevice-utilities-qml-modules + \ingroup qmlmodules \brief Provides a system-wide settings UI. The \c DeviceUtilities.SettingsUI module provides a single QML type, SettingsUI, that allows applications to integrate a standard, system-wide settings view into their user interface. - Import the module as follows: + To import and use the module's QML types, use the following statement: \badcode import QtDeviceUtilities.SettingsUI 1.0 diff --git a/src/timedatesettings/systemtime.cpp b/src/timedatesettings/systemtime.cpp index 3f3520b..1266cd3 100644 --- a/src/timedatesettings/systemtime.cpp +++ b/src/timedatesettings/systemtime.cpp @@ -31,9 +31,31 @@ QT_BEGIN_NAMESPACE +/*! + \module QtTimeDateSettings + \qtvariable timedatesettings + \ingroup qtdevice-utilities-cpp-modules + \ingroup modules + \title Qt Time and Date Settings C++ Classes + \brief Provides functionality for controlling time and date settings. + + To use classes from this module, add this directive into the C++ files: + + \code + #include + \endcode + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += timedatesettings + \endcode +*/ + /*! \class SystemTime - \inmodule QtDeviceUtilities + \inmodule QtTimeDateSettings \brief The SystemTime class manages the system date and time. */ diff --git a/src/timedatesettings/timezonemodel.cpp b/src/timedatesettings/timezonemodel.cpp index eec7450..5eae862 100644 --- a/src/timedatesettings/timezonemodel.cpp +++ b/src/timedatesettings/timezonemodel.cpp @@ -37,7 +37,7 @@ QT_BEGIN_NAMESPACE /*! \class TimezoneItem - \inmodule QtDeviceUtilities + \inmodule QtTimeDateSettings \brief The TimezoneItem class represents a time zone. */ @@ -107,7 +107,7 @@ QString TimezoneItem::id() const /*! \class TimezoneModel - \inmodule QtDeviceUtilities + \inmodule QtTimeDateSettings \brief The TimezoneModel class provides a model for the available time zones. -- cgit v1.2.3