Qt Network: Added the \inmodule command in the class documentation.
authorMichalina Ziemba <michalina.ziemba@nokia.com>
Tue, 14 Feb 2012 12:27:58 +0000 (13:27 +0100)
committerQt by Nokia <qt-info@nokia.com>
Thu, 16 Feb 2012 01:00:03 +0000 (02:00 +0100)
-Some of the public classes were missing the \inmodule command.
-Fixed a sentence.

Change-Id: I88ebe12680c744e32253dc01c5ddb4292267caf9
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
src/network/access/qnetworkcookie.cpp
src/network/access/qnetworkcookiejar.cpp
src/network/access/qnetworkrequest.cpp
src/network/kernel/qnetworkinterface.cpp
src/network/kernel/qnetworkproxy.cpp
src/network/kernel/qurlinfo.cpp
src/network/socket/qlocalserver.cpp
src/network/socket/qlocalsocket.cpp

index c987c50..88b021d 100644 (file)
@@ -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
index 4136043..a7436cb 100644 (file)
@@ -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
index b9c149e..ef81b60 100644 (file)
@@ -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
index 7b68ed6..947b2ab 100644 (file)
@@ -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
index 295260f..1181497 100644 (file)
@@ -853,7 +853,7 @@ template<> void QSharedDataPointer<QNetworkProxyQueryPrivate>::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
index a446f03..9f571b9 100644 (file)
@@ -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(),
index 05f2688..e984821 100644 (file)
@@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \class QLocalServer
     \since 4.4
+    \inmodule QtNetwork
 
     \brief The QLocalServer class provides a local socket based server.
 
index 3097eaa..ced7bba 100644 (file)
@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \class QLocalSocket
     \since 4.4
+    \inmodule QtNetwork
 
     \brief The QLocalSocket class provides a local socket.