diff options
| author | Martin Smith <martin.smith@nokia.com> | 2012-01-12 08:42:08 +0100 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-01-13 04:04:09 +0100 |
| commit | c373c538e8348ef84e08fd168a86b71863a9c145 (patch) | |
| tree | 1ff48b027a3bc0c539d7986b04586d5964b2aaea /src/network | |
| parent | 9b1dcfe901c06b887a2bb48b3ea0ddca69de1bbe (diff) | |
qdoc3: Don't put a \table in a \value
In qdoc, the \value command is meant to document a single value of an
enum. e.g.
\value TypeOfService Text describing the type of service. It runs until
the next \value or a blank line.
Although it doesn't say you can't build a \table in the \value text,
it doesn't work. For now, the fix is to remove the \table from the
\value text and make the table separate from the enum \value list and
let the description of the \table refer to the value that it belongs
to.
Task-number: QTBUG-23599
Change-Id: I88b456dca419a565eece30ba20fe09c0bcd4d98d
Reviewed-by: Martin Smith <martin.smith@nokia.com>
Reviewed-by: Jonas Gastal <jgastal@profusion.mobi>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/network')
| -rw-r--r-- | src/network/socket/qabstractsocket.cpp | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp index 4d70684563..e1a2449593 100644 --- a/src/network/socket/qabstractsocket.cpp +++ b/src/network/socket/qabstractsocket.cpp @@ -349,20 +349,29 @@ \enum QAbstractSocket::SocketOption \since 4.6 - This enum represents the options that can be set on a socket. - If desired, they can be set after having received the connected() signal from - the socket or after having received a new socket from a QTcpServer. + This enum represents the options that can be set on a socket. If + desired, they can be set after having received the connected() + signal from the socket or after having received a new socket from + a QTcpServer. - \value LowDelayOption Try to optimize the socket for low latency. For a QTcpSocket - this would set the TCP_NODELAY option and disable Nagle's algorithm. Set this to 1 - to enable. - \value KeepAliveOption Set this to 1 to enable the SO_KEEPALIVE socket option + \value LowDelayOption Try to optimize the socket for low + latency. For a QTcpSocket this would set the TCP_NODELAY option + and disable Nagle's algorithm. Set this to 1 to enable. - \value MulticastTtlOption Set this to an integer value to set IP_MULTICAST_TTL (TTL for multicast datagrams) socket option. + \value KeepAliveOption Set this to 1 to enable the SO_KEEPALIVE + socket option - \value MulticastLoopbackOption Set this to 1 to enable the IP_MULTICAST_LOOP (multicast loopback) socket option. + \value MulticastTtlOption Set this to an integer value to set + IP_MULTICAST_TTL (TTL for multicast datagrams) socket option. + + \value MulticastLoopbackOption Set this to 1 to enable the + IP_MULTICAST_LOOP (multicast loopback) socket option. + + \value TypeOfServiceOption This option is not supported on + Windows. This maps to to the IP_TOS socket option. + + Possible values for the \e{TypeOfServiceOption} are: - \value TypeOfServiceOption This option is not supported on Windows. This maps to to the IP_TOS socket option. Possible values are: \table \header \o Value \o Description \row \o 224 \o Network control |