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>
This commit is contained in:
Leena Miettinen
2020-02-06 14:51:12 +01:00
parent d34e93e58d
commit 0e6d0616fc

View File

@@ -34,9 +34,10 @@
#endif #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. with \QC.
Common initialization, \QC User Agent. Common initialization, \QC User Agent.
@@ -55,6 +56,10 @@ void cleanupNetworkAccessManager()
namInstance = nullptr; namInstance = nullptr;
} }
/*!
Returns a network access manager instance that should be used for the main
thread.
*/
NetworkAccessManager *NetworkAccessManager::instance() NetworkAccessManager *NetworkAccessManager::instance()
{ {
if (!namInstance) { if (!namInstance) {
@@ -64,12 +69,19 @@ NetworkAccessManager *NetworkAccessManager::instance()
return namInstance; return namInstance;
} }
/*!
Constructs a network access manager instance with the parent \a parent.
*/
NetworkAccessManager::NetworkAccessManager(QObject *parent) NetworkAccessManager::NetworkAccessManager(QObject *parent)
: QNetworkAccessManager(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) QNetworkReply* NetworkAccessManager::createRequest(Operation op, const QNetworkRequest &request, QIODevice *outgoingData)
{ {
QString agentStr = QString::fromLatin1("%1/%2 (QNetworkAccessManager %3; %4; %5; %6 bit)") QString agentStr = QString::fromLatin1("%1/%2 (QNetworkAccessManager %3; %4; %5; %6 bit)")