summaryrefslogtreecommitdiffstats
path: root/src/network/socket/qudpsocket.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/network/socket/qudpsocket.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff)
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/network/socket/qudpsocket.cpp')
-rw-r--r--src/network/socket/qudpsocket.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/network/socket/qudpsocket.cpp b/src/network/socket/qudpsocket.cpp
index a01fdd4646..de2fc22018 100644
--- a/src/network/socket/qudpsocket.cpp
+++ b/src/network/socket/qudpsocket.cpp
@@ -66,7 +66,7 @@
you don't need to call bind().
The readyRead() signal is emitted whenever datagrams arrive. In
- that case, hasPendingDatagrams() returns true. Call
+ that case, hasPendingDatagrams() returns \c true. Call
pendingDatagramSize() to obtain the size of the first pending
datagram, and readDatagram() to read it.
@@ -182,7 +182,7 @@ QUdpSocket::~QUdpSocket()
be bound using IPv6 (or in dual mode, using QHostAddress::Any). You must use
QHostAddress::AnyIPv4 instead.
- This function returns true if successful; otherwise it returns false
+ This function returns \c true if successful; otherwise it returns \c false
and sets the socket error accordingly.
\sa leaveMulticastGroup()
@@ -216,7 +216,7 @@ bool QUdpSocket::joinMulticastGroup(const QHostAddress &groupAddress,
interface chosen by the operating system. The socket must be in BoundState,
otherwise an error occurs.
- This function returns true if successful; otherwise it returns false and
+ This function returns \c true if successful; otherwise it returns \c false and
sets the socket error accordingly.
\sa joinMulticastGroup()
@@ -284,8 +284,8 @@ void QUdpSocket::setMulticastInterface(const QNetworkInterface &iface)
#endif // QT_NO_NETWORKINTERFACE
/*!
- Returns true if at least one datagram is waiting to be read;
- otherwise returns false.
+ Returns \c true if at least one datagram is waiting to be read;
+ otherwise returns \c false.
\sa pendingDatagramSize(), readDatagram()
*/