summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-06 14:51:12 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-06 16:04:46 +0000
commit0e6d0616fce407f7fd87a77d900dad4d4aa1b70f (patch)
tree578bd4f5fb46ed494728ac3c106731846bc2ddbd
parentd34e93e58dcf57d6ba2c892596e5c7750379396e (diff)
downloadqt-creator-0e6d0616fce407f7fd87a77d900dad4d4aa1b70f.tar.gz
Doc: Fix Utils::NetworkAccessManager class docs
- Fix class name in the \class command - Add missing docs Task-number: QTCREATORBUG-23544 Change-Id: I6ec6b6637cd6d766bb5870f01d5f374f32c7fe12 Reviewed-by: Orgad Shaneh <orgads@gmail.com>
-rw-r--r--src/libs/utils/networkaccessmanager.cpp16
1 files changed, 14 insertions, 2 deletions
diff --git a/src/libs/utils/networkaccessmanager.cpp b/src/libs/utils/networkaccessmanager.cpp
index 2409149525..59aa330373 100644
--- a/src/libs/utils/networkaccessmanager.cpp
+++ b/src/libs/utils/networkaccessmanager.cpp
@@ -34,9 +34,10 @@
#endif
/*!
- \class Utils::NetworkManager
+ \class Utils::NetworkAccessManager
+ \inmodule QtCreator
- \brief The NetworkManager class provides a network access manager for use
+ \brief The NetworkAccessManager class provides a network access manager for use
with \QC.
Common initialization, \QC User Agent.
@@ -55,6 +56,10 @@ void cleanupNetworkAccessManager()
namInstance = nullptr;
}
+/*!
+ Returns a network access manager instance that should be used for the main
+ thread.
+*/
NetworkAccessManager *NetworkAccessManager::instance()
{
if (!namInstance) {
@@ -64,12 +69,19 @@ NetworkAccessManager *NetworkAccessManager::instance()
return namInstance;
}
+/*!
+ Constructs a network access manager instance with the parent \a parent.
+*/
NetworkAccessManager::NetworkAccessManager(QObject *parent)
: QNetworkAccessManager(parent)
{
}
+/*!
+ Creates \a request for the network access manager to perform the operation
+ \a op on \a outgoingData.
+*/
QNetworkReply* NetworkAccessManager::createRequest(Operation op, const QNetworkRequest &request, QIODevice *outgoingData)
{
QString agentStr = QString::fromLatin1("%1/%2 (QNetworkAccessManager %3; %4; %5; %6 bit)")