diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 15:28:31 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 23:16:25 +0100 |
commit | 95d83cb1b68cc4a415d5d80859b4e74472ad7112 (patch) | |
tree | 9f6fa892ee78f584224320a195f03419c0fdbc21 /src/network/socket | |
parent | 15e136d4e116c1513c106dfbb75e1953a7f3463c (diff) |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I519bf9c29b14092e3ab6067612f42bf749eeedf5
Reviewed-by: Shane Kearns <shane.kearns@accenture.com>
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Diffstat (limited to 'src/network/socket')
-rw-r--r-- | src/network/socket/qabstractsocket.cpp | 34 | ||||
-rw-r--r-- | src/network/socket/qtcpsocket.cpp | 2 |
2 files changed, 18 insertions, 18 deletions
diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp index 75e99fe223..2f66671530 100644 --- a/src/network/socket/qabstractsocket.cpp +++ b/src/network/socket/qabstractsocket.cpp @@ -56,8 +56,8 @@ you need a socket, you have two options: \list - \i Instantiate QTcpSocket or QUdpSocket. - \i Create a native socket descriptor, instantiate + \li Instantiate QTcpSocket or QUdpSocket. + \li Create a native socket descriptor, instantiate QAbstractSocket, and call setSocketDescriptor() to wrap the native socket. \endlist @@ -129,15 +129,15 @@ can be used to implement blocking sockets: \list - \o waitForConnected() blocks until a connection has been established. + \li waitForConnected() blocks until a connection has been established. - \o waitForReadyRead() blocks until new data is available for + \li waitForReadyRead() blocks until new data is available for reading. - \o waitForBytesWritten() blocks until one payload of data has been + \li waitForBytesWritten() blocks until one payload of data has been written to the socket. - \o waitForDisconnected() blocks until the connection has closed. + \li waitForDisconnected() blocks until the connection has closed. \endlist We show an example: @@ -377,15 +377,15 @@ Possible values for the \e{TypeOfServiceOption} are: \table - \header \o Value \o Description - \row \o 224 \o Network control - \row \o 192 \o Internetwork control - \row \o 160 \o CRITIC/ECP - \row \o 128 \o Flash override - \row \o 96 \o Flash - \row \o 64 \o Immediate - \row \o 32 \o Priority - \row \o 0 \o Routine + \header \li Value \li Description + \row \li 224 \li Network control + \row \li 192 \li Internetwork control + \row \li 160 \li CRITIC/ECP + \row \li 128 \li Flash override + \row \li 96 \li Flash + \row \li 64 \li Immediate + \row \li 32 \li Priority + \row \li 0 \li Routine \endtable \sa QAbstractSocket::setSocketOption(), QAbstractSocket::socketOption() @@ -1510,7 +1510,7 @@ bool QAbstractSocket::bind(quint16 port, BindMode mode) Returns true if the socket is valid and ready for use; otherwise returns false. - \bold{Note:} The socket's state must be ConnectedState before reading and + \b{Note:} The socket's state must be ConnectedState before reading and writing can occur. \sa state() @@ -1792,7 +1792,7 @@ qintptr QAbstractSocket::socketDescriptor() const The socket is opened in the mode specified by \a openMode, and enters the socket state specified by \a socketState. - \bold{Note:} It is not possible to initialize two abstract sockets + \b{Note:} It is not possible to initialize two abstract sockets with the same native socket descriptor. \sa socketDescriptor() diff --git a/src/network/socket/qtcpsocket.cpp b/src/network/socket/qtcpsocket.cpp index 706f5721b2..dff8b5efb5 100644 --- a/src/network/socket/qtcpsocket.cpp +++ b/src/network/socket/qtcpsocket.cpp @@ -58,7 +58,7 @@ allows you to establish a TCP connection and transfer streams of data. See the QAbstractSocket documentation for details. - \bold{Note:} TCP sockets cannot be opened in QIODevice::Unbuffered mode. + \b{Note:} TCP sockets cannot be opened in QIODevice::Unbuffered mode. \sa QTcpServer, QUdpSocket, QNetworkAccessManager, {Fortune Server Example}, {Fortune Client Example}, |