diff --git a/src/network/access/qhttpheaders.cpp b/src/network/access/qhttpheaders.cpp index 24489e8b1b5..23ac003618a 100644 --- a/src/network/access/qhttpheaders.cpp +++ b/src/network/access/qhttpheaders.cpp @@ -35,7 +35,7 @@ Q_LOGGING_CATEGORY(lcQHttpHeaders, "qt.network.http.headers"); \l {https://datatracker.ietf.org/doc/html/rfc9110#name-field-values} {RFC 9110 Chapters 5.1 and 5.5}. - Broadly speaking, this means: + In all, this means: \list \li \c name must consist of visible ASCII characters, and must not be empty @@ -44,10 +44,9 @@ Q_LOGGING_CATEGORY(lcQHttpHeaders, "qt.network.http.headers"); may be empty \endlist - Furthermore, \e value may have historically contained leading or - trailing whitespace, which has to be ignored while processing such - values. The setters of this class automatically remove any such - whitespace. + The setters of this class automatically remove any leading or trailing + whitespaces from \e value, as they must be ignored during the + \e value processing. \section1 Combining values @@ -62,11 +61,10 @@ Q_LOGGING_CATEGORY(lcQHttpHeaders, "qt.network.http.headers"); myheadername: myheadervalue1,myheadervalue2 \endcode - However there is a notable exception to this rule: + However, there is a notable exception to this rule: \l {https://datatracker.ietf.org/doc/html/rfc9110#name-field-order} - {Set-Cookie}. Due to this, as well as due to the possibility - of custom use cases, QHttpHeaders does not automatically combine - the values. + {Set-Cookie}. Due to this and the possibility of custom use cases, + QHttpHeaders does not automatically combine the values. */ // This list is from IANA HTTP Field Name Registry diff --git a/src/network/access/qnetworkrequestfactory.cpp b/src/network/access/qnetworkrequestfactory.cpp index 517adad9996..072349e1554 100644 --- a/src/network/access/qnetworkrequestfactory.cpp +++ b/src/network/access/qnetworkrequestfactory.cpp @@ -220,8 +220,8 @@ QNetworkRequest QNetworkRequestFactory::createRequest(const QUrlQuery &query) co /*! Returns a QNetworkRequest. - The returned request's URL is formed by appending the provided \a path - and \a query to the baseUrl (which may itself have a path component). + The returned requests URL is formed by appending the provided \a path + and \a query to the baseUrl (which may have a path component). If the provided \a path contains query items, they will be combined with the items in \a query. @@ -276,13 +276,13 @@ void QNetworkRequestFactory::clearCommonHeaders() The bearer token, if present, is used to set the \c {Authorization: Bearer my_token} header for requests. This is a common - authorization convention and provided as an additional convenience. + authorization convention and is provided as an additional convenience. - Means to acquire the bearer token varies. Common methods include \c OAuth2 - and the service provider's website/dashboard. It's common that the bearer - token changes over time, for example when updated with a refresh token. - By always re-setting the new token ensures that subsequent requests will - always have the latest, valid, token. + The means to acquire the bearer token vary. Standard methods include \c OAuth2 + and the service provider's website/dashboard. It is expected that the bearer + token changes over time. For example, when updated with a refresh token, + always setting the new token again ensures that subsequent requests have + the latest, valid token. The presence of the bearer token does not impact the \l commonHeaders() listing. If the \l commonHeaders() also lists \c Authorization header, it diff --git a/src/network/access/qrestaccessmanager.cpp b/src/network/access/qrestaccessmanager.cpp index 4efe2d3b1b9..6f5a9675dbf 100644 --- a/src/network/access/qrestaccessmanager.cpp +++ b/src/network/access/qrestaccessmanager.cpp @@ -42,8 +42,8 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest") take ownership of the wrapped QNetworkAccessManager. QRestAccessManager and related QRestReply classes can only be used in the - thread they live in. For further information see - \l {QObject#Thread Affinity}{QObject thread affinity} documentation. + thread they live in. See \l {QObject#Thread Affinity}{QObject thread affinity} + for more information. \section1 Issuing Network Requests and Handling Replies diff --git a/src/network/access/qrestreply.cpp b/src/network/access/qrestreply.cpp index 07ffe06c6f3..1483fc1b3a6 100644 --- a/src/network/access/qrestreply.cpp +++ b/src/network/access/qrestreply.cpp @@ -146,11 +146,10 @@ QByteArray QRestReply::readBody() /*! Returns the received data as a QString. - The received data is decoded into a QString (UTF-16). The decoding + The received data is decoded into a QString (UTF-16). If available, the decoding uses the \e Content-Type header's \e charset parameter to determine the - source encoding, if available. If the encoding information is not - available or not supported by \l QStringConverter, UTF-8 is used as a - default. + source encoding. If the encoding information is not available or not supported + by \l QStringConverter, UTF-8 is used by default. Calling this function consumes the data received so far. Returns a default constructed value if no new data is available, or if the @@ -196,8 +195,8 @@ QString QRestReply::readText() yet). \note The HTTP status is reported as indicated by the received HTTP - response. It is possible that an error() occurs after receiving the status, - for instance due to network disconnection while receiving a long response. + response. An error() may occur after receiving the status, for instance + due to network disconnection while receiving a long response. These potential subsequent errors are not represented by the reported HTTP status. @@ -212,7 +211,7 @@ int QRestReply::httpStatus() const \fn bool QRestReply::isSuccess() const Returns whether the HTTP status is between 200..299 and no - further errors have occurred while receiving the response (for example + further errors have occurred while receiving the response (for example, abrupt disconnection while receiving the body data). This function is a convenient way to check whether the response is considered successful.