diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
| commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
| tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/network/bearer/qnetworksession.cpp | |
| parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/bearer/qnetworksession.cpp')
| -rw-r--r-- | src/network/bearer/qnetworksession.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/network/bearer/qnetworksession.cpp b/src/network/bearer/qnetworksession.cpp index cca95fce8c..98a8f27a6e 100644 --- a/src/network/bearer/qnetworksession.cpp +++ b/src/network/bearer/qnetworksession.cpp @@ -314,7 +314,7 @@ void QNetworkSession::open() /*! Waits until the session has been opened, up to \a msecs milliseconds. If the session has been opened, this - function returns true; otherwise it returns false. In the case where it returns false, you can call error() + function returns \c true; otherwise it returns \c false. In the case where it returns \c false, you can call error() to determine the cause of the error. The following example waits up to one second for the session to be opened: @@ -415,7 +415,7 @@ QNetworkInterface QNetworkSession::interface() const #endif /*! - Returns true if this session is open. If the number of all open sessions is greater than + Returns \c true if this session is open. If the number of all open sessions is greater than zero the underlying network interface will remain connected/up. The session can be controlled via open() and close(). |