summaryrefslogtreecommitdiffstats
path: root/src/network/socket/qlocalserver.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/qlocalserver.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/qlocalserver.cpp')
-rw-r--r--src/network/socket/qlocalserver.cpp12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/network/socket/qlocalserver.cpp b/src/network/socket/qlocalserver.cpp
index 95782cc1c3..f7f8aab182 100644
--- a/src/network/socket/qlocalserver.cpp
+++ b/src/network/socket/qlocalserver.cpp
@@ -218,8 +218,8 @@ QString QLocalServer::errorString() const
}
/*!
- 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()
*/
@@ -254,7 +254,7 @@ void QLocalServer::incomingConnection(quintptr socketDescriptor)
}
/*!
- Returns true if the server is listening for incoming connections
+ Returns \c true if the server is listening for incoming connections
otherwise false.
\sa listen(), close()
@@ -399,7 +399,7 @@ QLocalSocket *QLocalServer::nextPendingConnection()
\since 4.5
Removes any server instance that might cause a call to listen() to fail
- and returns true if successful; otherwise returns false.
+ and returns \c true if successful; otherwise returns \c false.
This function is meant to recover from a crash, when the previous server
instance has not been cleaned up.
@@ -470,8 +470,8 @@ void QLocalServer::setMaxPendingConnections(int numConnections)
/*!
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 and \a timedOut is not 0,
+ 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,
*timedOut will be set to true.
This is a blocking function call. Its use is ill-advised in a