From 6a5d1370b3209c7c5ed6fc498190deff69e74552 Mon Sep 17 00:00:00 2001 From: Michalina Ziemba Date: Tue, 14 Feb 2012 13:27:58 +0100 Subject: Qt Network: Added the \inmodule command in the class documentation. -Some of the public classes were missing the \inmodule command. -Fixed a sentence. Change-Id: I88ebe12680c744e32253dc01c5ddb4292267caf9 Reviewed-by: Lars Knoll --- src/network/access/qnetworkcookie.cpp | 2 ++ src/network/access/qnetworkcookiejar.cpp | 4 +++- src/network/access/qnetworkrequest.cpp | 8 ++++---- src/network/kernel/qnetworkinterface.cpp | 2 ++ src/network/kernel/qnetworkproxy.cpp | 2 +- src/network/kernel/qurlinfo.cpp | 1 + src/network/socket/qlocalserver.cpp | 1 + src/network/socket/qlocalsocket.cpp | 1 + 8 files changed, 15 insertions(+), 6 deletions(-) (limited to 'src/network') diff --git a/src/network/access/qnetworkcookie.cpp b/src/network/access/qnetworkcookie.cpp index c987c50017..88b021d780 100644 --- a/src/network/access/qnetworkcookie.cpp +++ b/src/network/access/qnetworkcookie.cpp @@ -58,6 +58,8 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkCookie \since 4.4 + \inmodule QtNetwork + \brief The QNetworkCookie class holds one network cookie. Cookies are small bits of information that stateless protocols diff --git a/src/network/access/qnetworkcookiejar.cpp b/src/network/access/qnetworkcookiejar.cpp index 4136043e2e..a7436cb38c 100644 --- a/src/network/access/qnetworkcookiejar.cpp +++ b/src/network/access/qnetworkcookiejar.cpp @@ -51,8 +51,10 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkCookieJar - \brief The QNetworkCookieJar class implements a simple jar of QNetworkCookie objects \since 4.4 + \inmodule QtNetwork + + \brief The QNetworkCookieJar class implements a simple jar of QNetworkCookie objects Cookies are small bits of information that stateless protocols like HTTP use to maintain some persistent information across diff --git a/src/network/access/qnetworkrequest.cpp b/src/network/access/qnetworkrequest.cpp index b9c149e5d8..ef81b6081d 100644 --- a/src/network/access/qnetworkrequest.cpp +++ b/src/network/access/qnetworkrequest.cpp @@ -57,12 +57,12 @@ QT_BEGIN_NAMESPACE /*! \class QNetworkRequest - \brief The QNetworkRequest class holds a request to be sent with QNetworkAccessManager. \since 4.4 - \ingroup network \inmodule QtNetwork + \brief The QNetworkRequest class holds a request to be sent with QNetworkAccessManager. + QNetworkRequest is part of the Network Access API and is the class holding the information necessary to send a request over the network. It contains a URL and some ancillary information that can @@ -115,7 +115,7 @@ QT_BEGIN_NAMESPACE /*! \enum QNetworkRequest::Attribute \since 4.7 - + Attribute codes for the QNetworkRequest and QNetworkReply. Attributes are extra meta-data that are used to control the @@ -606,7 +606,7 @@ QNetworkRequest::Priority QNetworkRequest::priority() const /*! \enum QNetworkRequest::Priority \since 4.7 - + This enum lists the possible network request priorities. \value HighPriority High priority diff --git a/src/network/kernel/qnetworkinterface.cpp b/src/network/kernel/qnetworkinterface.cpp index 7b68ed6c12..947b2ab0d9 100644 --- a/src/network/kernel/qnetworkinterface.cpp +++ b/src/network/kernel/qnetworkinterface.cpp @@ -149,6 +149,7 @@ QString QNetworkInterfacePrivate::makeHwAddress(int len, uchar *data) \since 4.2 \reentrant \ingroup network + \inmodule QtNetwork Each network interface can contain zero or more IP addresses, which in turn can be associated with a netmask and/or a broadcast @@ -333,6 +334,7 @@ void QNetworkAddressEntry::setBroadcast(const QHostAddress &newBroadcast) \since 4.2 \reentrant \ingroup network + \inmodule QtNetwork QNetworkInterface represents one network interface attached to the host where the program is being run. Each network interface may diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp index 295260f7f1..1181497d82 100644 --- a/src/network/kernel/qnetworkproxy.cpp +++ b/src/network/kernel/qnetworkproxy.cpp @@ -853,7 +853,7 @@ template<> void QSharedDataPointer::detach() \since 4.5 \inmodule QtNetwork \brief The QNetworkProxyQuery class is used to query the proxy - settings for a socket + settings for a socket. QNetworkProxyQuery holds the details of a socket being created or request being made. It is used by QNetworkProxy and diff --git a/src/network/kernel/qurlinfo.cpp b/src/network/kernel/qurlinfo.cpp index a446f03b85..9f571b9e8c 100644 --- a/src/network/kernel/qurlinfo.cpp +++ b/src/network/kernel/qurlinfo.cpp @@ -86,6 +86,7 @@ public: \ingroup io \ingroup network + \inmodule QtNetwork The information about a URL that can be retrieved includes name(), permissions(), owner(), group(), size(), lastModified(), diff --git a/src/network/socket/qlocalserver.cpp b/src/network/socket/qlocalserver.cpp index 05f26883d3..e9848213d8 100644 --- a/src/network/socket/qlocalserver.cpp +++ b/src/network/socket/qlocalserver.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE /*! \class QLocalServer \since 4.4 + \inmodule QtNetwork \brief The QLocalServer class provides a local socket based server. diff --git a/src/network/socket/qlocalsocket.cpp b/src/network/socket/qlocalsocket.cpp index 3097eaa96c..ced7bba09b 100644 --- a/src/network/socket/qlocalsocket.cpp +++ b/src/network/socket/qlocalsocket.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE /*! \class QLocalSocket \since 4.4 + \inmodule QtNetwork \brief The QLocalSocket class provides a local socket. -- cgit v1.2.3