diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-08-12 15:36:40 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-08-31 07:12:13 +0200 |
| commit | 49e8d0f3d5836e0fc1577ace1f0a3677d0e309b7 (patch) | |
| tree | 1c54ee225a2ee22b862b29c2c06bbba914e5cc19 /src/network/access | |
| parent | 0ac7a81250e7291d12d9a176197260344884419c (diff) | |
Doc: Fix documentation warnings in Qt Network
Pick-to: 5.15
Change-Id: I3653977a4511aa5c296a3954399342d98ac71586
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/network/access')
| -rw-r--r-- | src/network/access/qhttp2configuration.cpp | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/src/network/access/qhttp2configuration.cpp b/src/network/access/qhttp2configuration.cpp index bd4318d4e9..408f141e77 100644 --- a/src/network/access/qhttp2configuration.cpp +++ b/src/network/access/qhttp2configuration.cpp @@ -141,12 +141,12 @@ QHttp2Configuration::QHttp2Configuration(QHttp2Configuration &&other) noexcept } /*! - Copy-assigns to this QHttp2Configuration. + Copy-assigns \a other to this QHttp2Configuration. */ QHttp2Configuration &QHttp2Configuration::operator=(const QHttp2Configuration &) = default; /*! - Move-assigns to this QHttp2Configuration. + Move-assigns \a other to this QHttp2Configuration. */ QHttp2Configuration &QHttp2Configuration::operator=(QHttp2Configuration &&) noexcept = default; @@ -209,6 +209,8 @@ bool QHttp2Configuration::huffmanCompressionEnabled() const Sets the window size for connection-level flow control. \a size cannot be 0 and must not exceed 2147483647 octets. + Returns \c true on success, \c false otherwise. + \sa sessionReceiveWindowSize */ bool QHttp2Configuration::setSessionReceiveWindowSize(unsigned size) @@ -236,6 +238,8 @@ unsigned QHttp2Configuration::sessionReceiveWindowSize() const Sets the window size for stream-level flow control. \a size cannot be 0 and must not exceed 2147483647 octets. + Returns \c true on success, \c false otherwise. + \sa streamReceiveWindowSize */ bool QHttp2Configuration::setStreamReceiveWindowSize(unsigned size) @@ -265,6 +269,8 @@ unsigned QHttp2Configuration::streamReceiveWindowSize() const \note While this \a size is required to be within a range between 16384 and 16777215 inclusive, the actual payload size in frames that carry payload maybe be less than 16384. + + Returns \c true on success, \c false otherwise. */ bool QHttp2Configuration::setMaxFrameSize(unsigned size) { @@ -278,7 +284,7 @@ bool QHttp2Configuration::setMaxFrameSize(unsigned size) } /*! - The maximum payload size that HTTP/2 frames can + Returns the maximum payload size that HTTP/2 frames can have. The default (initial) value is 16384 octets. */ unsigned QHttp2Configuration::maxFrameSize() const |