diff options
| author | Jaishree Vyas <jaishree.vyas@qt.io> | 2024-02-28 11:53:12 +0100 |
|---|---|---|
| committer | Jaishree Vyas <jaishree.vyas@qt.io> | 2024-02-29 11:44:12 +0100 |
| commit | d7b71294e8267123595593efca397151e4bf2595 (patch) | |
| tree | 211d599f7a592bc3ddbb4ecee3941f3f2951fa65 /src/network/access/qrestreply.cpp | |
| parent | fb5ffe862688a87cfc136113e067bcba0c49a7ae (diff) | |
Doc: Documentation improvement in QHttpHeaders and REST classes
Language and some other improvisations
Fixes: QTBUG-120028
Pick-to: 6.7
Change-Id: Id5a5544abf244de5cff83f0d795732595934bd36
Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
Diffstat (limited to 'src/network/access/qrestreply.cpp')
| -rw-r--r-- | src/network/access/qrestreply.cpp | 13 |
1 files changed, 6 insertions, 7 deletions
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. |