Some docs for QWebNetworkRequest
authorhausmann <hausmann@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 13 Jun 2007 13:04:08 +0000 (13:04 +0000)
committerhausmann <hausmann@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 13 Jun 2007 13:04:08 +0000 (13:04 +0000)
git-svn-id: https://svn.webkit.org/repository/webkit/trunk@23493 268f45cc-cd09-0410-ab3c-d52691b4dbfc

WebKitQt/Api/qwebnetworkinterface.cpp
WebKitQt/ChangeLog

index 09bd47376e44daf386dbf0b0c10476e42a0ff8bb..277a9fd5227ce9cda8b0da848cc4049a8861ffa6 100644 (file)
@@ -105,6 +105,14 @@ void QWebNetworkRequestPrivate::setURL(const QUrl &u)
         httpHeader.setValue(QLatin1String("Host"), url.host());
 }
 
+/*!
+  \class QWebNetworkRequest
+
+  The QWebNetworkRequest class represents a request for data from the network with all the
+  necessary information needed for retrieval. This includes the url, extra HTTP header fields
+  as well as data for a HTTP POST request.
+*/
+
 QWebNetworkRequest::QWebNetworkRequest()
     : d(new QWebNetworkRequestPrivate)
 {
@@ -131,16 +139,27 @@ QWebNetworkRequest::~QWebNetworkRequest()
     delete d;
 }
 
+/*!
+  The requested URL
+*/
 QUrl QWebNetworkRequest::url() const
 {
     return d->url;
 }
 
+/*!
+   Sets the URL to request.
+
+   Note that setting the URL also sets the "Host" field in the HTTP header.
+*/
 void QWebNetworkRequest::setUrl(const QUrl &url)
 {
     d->setURL(url);
 }
 
+/*!
+   The http request header information.
+*/
 QHttpRequestHeader QWebNetworkRequest::httpHeader() const
 {
     return d->httpHeader;
@@ -151,6 +170,9 @@ void QWebNetworkRequest::setHttpHeader(const QHttpRequestHeader &header) const
     d->httpHeader = header;
 }
 
+/*!
+    Post data sent with HTTP POST requests.
+*/
 QByteArray QWebNetworkRequest::postData() const
 {
     return d->postData;
index bcc9b3fa06b409c33fe2b92fcf569ffb515c9c06..0a6c95bc3c32ed0adcda7072126fe80bfdfe7bce 100644 (file)
@@ -1,3 +1,13 @@
+2007-06-13  Simon Hausmann  <hausmann@kde.org>
+
+        Reviewed by Lars.
+
+        Some docs for QWebNetworkRequest
+
+        * Api/qwebnetworkinterface.cpp:
+        (QWebNetworkRequest::QWebNetworkRequest):
+        (QWebNetworkRequest::~QWebNetworkRequest):
+
 2007-06-13  Simon Hausmann  <hausmann@kde.org>
 
         Reviewed by Lars.