summaryrefslogtreecommitdiffstats
path: root/src/network/socket/qtcpserver.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/qtcpserver.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/qtcpserver.cpp')
-rw-r--r--src/network/socket/qtcpserver.cpp18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/network/socket/qtcpserver.cpp b/src/network/socket/qtcpserver.cpp
index 896980f849..31215ee307 100644
--- a/src/network/socket/qtcpserver.cpp
+++ b/src/network/socket/qtcpserver.cpp
@@ -271,7 +271,7 @@ QTcpServer::~QTcpServer()
automatically. If \a address is QHostAddress::Any, the server
will listen on all network interfaces.
- Returns true on success; otherwise returns false.
+ Returns \c true on success; otherwise returns \c false.
\sa isListening()
*/
@@ -351,8 +351,8 @@ bool QTcpServer::listen(const QHostAddress &address, quint16 port)
}
/*!
- Returns true if the server is currently listening for incoming
- connections; otherwise returns false.
+ Returns \c true if the server is currently listening for incoming
+ connections; otherwise returns \c false.
\sa listen()
*/
@@ -408,8 +408,8 @@ qintptr QTcpServer::socketDescriptor() const
/*!
Sets the socket descriptor this server should use when listening
- for incoming connections to \a socketDescriptor. Returns true if
- the socket is set successfully; otherwise returns false.
+ for incoming connections to \a socketDescriptor. Returns \c true if
+ the socket is set successfully; otherwise returns \c false.
The socket is assumed to be in listening state.
@@ -486,8 +486,8 @@ QHostAddress QTcpServer::serverAddress() const
/*!
Waits for at most \a msec milliseconds or until an incoming
- connection is available. Returns true if a connection is
- available; otherwise returns false. If the operation timed out
+ connection is available. Returns \c true if a connection is
+ available; otherwise returns \c false. If the operation timed out
and \a timedOut is not 0, *\a timedOut will be set to true.
This is a blocking function call. Its use is disadvised in a
@@ -524,8 +524,8 @@ bool QTcpServer::waitForNewConnection(int msec, bool *timedOut)
}
/*!
- Returns true if the server has a pending connection; otherwise
- returns false.
+ Returns \c true if the server has a pending connection; otherwise
+ returns \c false.
\sa nextPendingConnection(), setMaxPendingConnections()
*/