From 261e4c619214af5e5cf95ec08a7d46d702ae0a93 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Fri, 28 Sep 2018 15:23:47 +0200
Subject: Doc: Add documentation for C++ classes

Currently, only QML types are documented.

Task-number: QTBUG-69686
Change-Id: Idc13bff25a154e88c6c769c0af37204573ec1118
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
---
 src/networksettings/qnetworksettingsuseragent.cpp | 74 +++++++++++++++++++++++
 1 file changed, 74 insertions(+)

(limited to 'src/networksettings/qnetworksettingsuseragent.cpp')

diff --git a/src/networksettings/qnetworksettingsuseragent.cpp b/src/networksettings/qnetworksettingsuseragent.cpp
index cdf1e45..7458682 100644
--- a/src/networksettings/qnetworksettingsuseragent.cpp
+++ b/src/networksettings/qnetworksettingsuseragent.cpp
@@ -31,36 +31,110 @@
 
 QT_BEGIN_NAMESPACE
 
+/*!
+    \class QNetworkSettingsUserAgent
+    \inmodule QtDeviceUtilities
+
+    \brief The QNetworkSettingsUserAgent represents the user credentials for
+    connecting to a network.
+
+    The QNetworkSettingsService::connectService() method is used to connect to
+    a Wifi network. The network name is specified by using a service set
+    identifier (SSID). If no password is needed, the connection is created
+    immediately. QNetworkSettingsService::state property can be used to
+    monitor the state of the connection.
+
+    If a password is needed, the
+    QNetworkSettingsUserAgent::showUserCredentialsInput() signal is emitted.
+    To create a connection, the password is set by using the
+    QNetworkSettingsUserAgent::setPassphrase() method.
+
+    \sa QNetworkSettingsManager
+*/
+
+/*!
+    \fn QNetworkSettingsUserAgent::showUserCredentialsInput()
+
+    This signal is emitted when user credentials are required for connecting to
+    a Wifi network.
+
+    \sa QNetworkSettingsService::connectService()
+*/
+
+/*!
+    \fn QNetworkSettingsUserAgent::error()
+
+    This signal is emitted when the connection failed due to invalid user
+    credentials.
+*/
+
+/*!
+    \fn QNetworkSettingsUserAgent::ready(bool cancel)
+
+    This signal is emitted when the user has either submitted the password
+    for the network, or if \a cancel is \c true, cancelled the password
+    query.
+*/
+
+/*!
+    \fn QNetworkSettingsUserAgent::requestNextConnection()
+
+    This signal is emitted when the network manager attempts to connect using
+    the next network interface in the model.
+*/
+
+/*!
+    Creates a user agent with the parent \a parent.
+*/
 QNetworkSettingsUserAgent::QNetworkSettingsUserAgent(QObject *parent)
     :QObject(parent)
     ,d_ptr(new QNetworkSettingsUserAgentPrivate(this))
 {
 }
 
+/*!
+    Sets the password for connecting to a Wifi network to \a passphrase.
+
+    This method needs to be called in response to receiving the
+    \l showUserCredentialsInput() signal.
+*/
 void QNetworkSettingsUserAgent::setPassphrase(const QString &passphrase)
 {
     Q_D(QNetworkSettingsUserAgent);
     d->setPassphrase(passphrase);
 }
 
+/*!
+    Cancels the user credentials input request.
+*/
 void QNetworkSettingsUserAgent::cancelInput()
 {
     Q_D(QNetworkSettingsUserAgent);
     d->cancel();
 }
 
+/*!
+    Returns the password of the user agent.
+*/
 QString QNetworkSettingsUserAgent::passphrase() const
 {
     Q_D(const QNetworkSettingsUserAgent);
     return d->passphrase();
 }
 
+/*!
+    Sets the name of the network to \a ssid and the password of the user agent
+    to \a passphrase.
+*/
 void QNetworkSettingsUserAgent::setSsidAndPassphrase(const QString &ssid, const QString &passphrase)
 {
     Q_D(QNetworkSettingsUserAgent);
     d->setSsidAndPassphrase(ssid, passphrase);
 }
 
+/*!
+    Clears the connection state.
+*/
 void QNetworkSettingsUserAgent::clearConnectionState()
 {
     Q_D(QNetworkSettingsUserAgent);
-- 
cgit v1.2.3