From 77987a087507ecccb616a1af158190ffd3082a02 Mon Sep 17 00:00:00 2001 From: Lassi Lehikoinen Date: Wed, 23 Dec 2020 13:03:00 +0200 Subject: Update documentation regarding Qt 6 changes Task-number: QTBUG-88332 Change-Id: Ie6b9310e73b5515c97c892fbc27cd89009011c98 Reviewed-by: Samuli Piippo --- src/doc/src/qtdeviceutilities-index.qdoc | 37 ++++++++++++++------------- src/doc/src/qtdeviceutilities-module-cpp.qdoc | 15 ----------- src/doc/src/qtdeviceutilities-module-qml.qdoc | 24 ++--------------- src/doc/src/wifiexample.qdoc | 2 +- src/networksettings/qnetworksettings.cpp | 11 ++++++-- 5 files changed, 31 insertions(+), 58 deletions(-) (limited to 'src') diff --git a/src/doc/src/qtdeviceutilities-index.qdoc b/src/doc/src/qtdeviceutilities-index.qdoc index 53627da..3e4467e 100644 --- a/src/doc/src/qtdeviceutilities-index.qdoc +++ b/src/doc/src/qtdeviceutilities-index.qdoc @@ -31,7 +31,7 @@ \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: + applications. \QtDU provides the following C++ modules: \annotatedlist qtdevice-utilities-cpp-modules @@ -41,35 +41,36 @@ \section1 Getting Started - To include the definitions of the module's classes, use the following - directives: + To include the definitions of the module's class, use the following + directive: - \code - #include - #include - #include - #include + \badcode #include - #include \endcode - To link against the modules, add this line to your qmake .pro file: + \section2 Building with CMake + + If you're using CMake to build your application, add the following lines to your CMakeLists.txt file: + + \badcode + find_package(Qt6 COMPONENTS NetworkSettings REQUIRED) + target_link_libraries(mytarget Qt6::NetworkSettings) + \endcode + + \section2 Building with qmake + + If you're using qmake to build your application, add this line to your qmake .pro file: \badcode - QT += bluetoothsettings displaysettings localdevice localesettings networksettings timedatesettings + QT += networksettings \endcode To import the QML types into your application, use the following import statements in your .qml file: \code - import QtDeviceUtilities.BluetoothSettings 1.0 - import QtDeviceUtilities.DisplaySettings 1.0 - import QtDeviceUtilities.LocalDeviceSettings 1.0 - import QtDeviceUtilities.LocaleSettings 1.0 - import QtDeviceUtilities.NetworkSettings 1.0 - import QtDeviceUtilities.SettingsUI 1.0 - import QtDeviceUtilities.TimeDateSettings 1.0 + import QtDeviceUtilities.NetworkSettings + import QtDeviceUtilities.SettingsUI \endcode \section1 Examples diff --git a/src/doc/src/qtdeviceutilities-module-cpp.qdoc b/src/doc/src/qtdeviceutilities-module-cpp.qdoc index a6eef84..377bb25 100644 --- a/src/doc/src/qtdeviceutilities-module-cpp.qdoc +++ b/src/doc/src/qtdeviceutilities-module-cpp.qdoc @@ -35,22 +35,7 @@ \section1 Classes - \section2 Qt Bluetooth Settings Module - \generatelist {classesbymodule QtBluetoothSettings} - - \section2 Qt Display Settings Module - \generatelist {classesbymodule QtDisplaySettings} - - \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 bd08a8a..2c8fef5 100644 --- a/src/doc/src/qtdeviceutilities-module-qml.qdoc +++ b/src/doc/src/qtdeviceutilities-module-qml.qdoc @@ -34,36 +34,16 @@ following import statements in your .qml file: \badcode - import QtDeviceUtilities.BluetoothSettings 1.0 - import QtDeviceUtilities.DisplaySettings 1.0 - import QtDeviceUtilities.LocalDeviceSettings 1.0 - import QtDeviceUtilities.LocaleSettings 1.0 - import QtDeviceUtilities.NetworkSettings 1.0 - import QtDeviceUtilities.SettingsUI 1.0 - import QtDeviceUtilities.TimeDateSettings 1.0 + import QtDeviceUtilities.NetworkSettings + import QtDeviceUtilities.SettingsUI \endcode \section1 QML Types - \section2 Qt Bluetooth Settings Module - \generatelist qmltypesbymodule QtDeviceUtilities.BluetoothSettings - - \section2 Qt Display Settings Module - \generatelist qmltypesbymodule QtDeviceUtilities.DisplaySettings - - \section2 Qt Local Device Settings Module - \generatelist qmltypesbymodule QtDeviceUtilities.LocalDeviceSettings - - \section2 Qt Locale Settings Module - \generatelist qmltypesbymodule QtDeviceUtilities.LocaleSettings - \section2 Qt Network Settings Module \generatelist qmltypesbymodule QtDeviceUtilities.NetworkSettings \section2 Qt Settings UI Module \generatelist qmltypesbymodule QtDeviceUtilities.SettingsUI - - \section2 Qt Time and Date Settings Module - \generatelist qmltypesbymodule QtDeviceUtilities.TimeDateSettings */ diff --git a/src/doc/src/wifiexample.qdoc b/src/doc/src/wifiexample.qdoc index 2de002b..9a75f86 100644 --- a/src/doc/src/wifiexample.qdoc +++ b/src/doc/src/wifiexample.qdoc @@ -33,7 +33,7 @@ Import the NetworkSettings module as follows: \badcode - import QtDeviceUtilities.NetworkSettings 1.0 + import QtDeviceUtilities.NetworkSettings \endcode \section1 Filtering WiFi Networks diff --git a/src/networksettings/qnetworksettings.cpp b/src/networksettings/qnetworksettings.cpp index e4ddbad..79ec2d4 100644 --- a/src/networksettings/qnetworksettings.cpp +++ b/src/networksettings/qnetworksettings.cpp @@ -44,8 +44,15 @@ QT_BEGIN_NAMESPACE #include \endcode - To link against the corresponding C++ libraries, add the following to your - qmake project file: + To link against the corresponding C++ libraries when using CMake to build you application, + add the following to your CMakeLists.txt file: + + \code + find_package(Qt6 COMPONENTS NetworkSettings REQUIRED) + target_link_libraries(mytarget Qt6::NetworkSettings) + \endcode + + Or if you are using qmake to build your application, add the following line to your qmake .pro project file: \code QT += networksettings -- cgit v1.2.3