summaryrefslogtreecommitdiffstats
path: root/src/network/kernel/qnetworkproxy.cpp
diff options
context:
space:
mode:
authorShane Kearns <ext-shane.2.kearns@nokia.com>2012-05-03 18:10:19 +0100
committerQt by Nokia <qt-info@nokia.com>2012-05-03 19:34:58 +0200
commitbd7cd3467334dae70e4cd21a5df6c17e3e3ea4bf (patch)
treef3f22a711d2c525ca65e6218a94562b23050cc2a /src/network/kernel/qnetworkproxy.cpp
parent12dad8357d7449c0ecfc33a8b7b5e33099fa8e7e (diff)
Document new APIs in 5.0
The \since 5.0 directive was missing from many places. Task-number: QTBUG-24001 Change-Id: I191ba8891ae66d78f923164bcab2fccb16eabef9 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/network/kernel/qnetworkproxy.cpp')
-rw-r--r--src/network/kernel/qnetworkproxy.cpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp
index 501afce6fc..6c1ee0ef42 100644
--- a/src/network/kernel/qnetworkproxy.cpp
+++ b/src/network/kernel/qnetworkproxy.cpp
@@ -706,6 +706,7 @@ QNetworkProxy QNetworkProxy::applicationProxy()
}
/*!
+ \since 5.0
Returns the value of the known network header \a header if it is
in use for this proxy. If it is not present, returns QVariant()
(i.e., an invalid variant).
@@ -720,6 +721,7 @@ QVariant QNetworkProxy::header(QNetworkRequest::KnownHeaders header) const
}
/*!
+ \since 5.0
Sets the value of the known header \a header to be \a value,
overriding any previously set headers. This operation also sets
the equivalent raw HTTP header.
@@ -736,6 +738,7 @@ void QNetworkProxy::setHeader(QNetworkRequest::KnownHeaders header, const QVaria
}
/*!
+ \since 5.0
Returns true if the raw header \a headerName is in use for this
proxy. Returns false if the proxy is not of type HttpProxy or
HttpCachingProxy.
@@ -750,6 +753,7 @@ bool QNetworkProxy::hasRawHeader(const QByteArray &headerName) const
}
/*!
+ \since 5.0
Returns the raw form of header \a headerName. If no such header is
present or the proxy is not of type HttpProxy or HttpCachingProxy,
an empty QByteArray is returned, which may be indistinguishable
@@ -772,6 +776,7 @@ QByteArray QNetworkProxy::rawHeader(const QByteArray &headerName) const
}
/*!
+ \since 5.0
Returns a list of all raw headers that are set in this network
proxy. The list is in the order that the headers were set.
@@ -788,6 +793,7 @@ QList<QByteArray> QNetworkProxy::rawHeaderList() const
}
/*!
+ \since 5.0
Sets the header \a headerName to be of value \a headerValue. If \a
headerName corresponds to a known header (see
QNetworkRequest::KnownHeaders), the raw format will be parsed and
@@ -1521,6 +1527,10 @@ QList<QNetworkProxy> QNetworkProxyFactory::proxyForQuery(const QNetworkProxyQuer
}
#ifndef QT_NO_DEBUG_STREAM
+/*!
+ \since 5.0
+ Outputs a QNetworkProxy details to a debug stream
+*/
QDebug operator<<(QDebug debug, const QNetworkProxy &proxy)
{
QNetworkProxy::ProxyType type = proxy.type();