summaryrefslogtreecommitdiffstats
path: root/src/networksettings/qnetworksettings.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/networksettings/qnetworksettings.cpp')
-rw-r--r--src/networksettings/qnetworksettings.cpp36
1 files changed, 29 insertions, 7 deletions
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.
@@ -31,8 +31,30 @@
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 <QtNetworkSettings>
+ \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.
*/