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/corelib/thread/qreadwritelock.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/corelib/thread/qreadwritelock.cpp')
-rw-r--r-- | src/corelib/thread/qreadwritelock.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/corelib/thread/qreadwritelock.cpp b/src/corelib/thread/qreadwritelock.cpp index 0de826fddf..e4cdf7a985 100644 --- a/src/corelib/thread/qreadwritelock.cpp +++ b/src/corelib/thread/qreadwritelock.cpp @@ -172,7 +172,7 @@ void QReadWriteLock::lockForRead() /*! Attempts to lock for reading. If the lock was obtained, this - function returns true, otherwise it returns false instead of + function returns \c true, otherwise it returns \c false instead of waiting for the lock to become available, i.e. it does not block. The lock attempt will fail if another thread has locked for @@ -217,8 +217,8 @@ bool QReadWriteLock::tryLockForRead() /*! \overload - Attempts to lock for reading. This function returns true if the - lock was obtained; otherwise it returns false. If another thread + Attempts to lock for reading. This function returns \c true if the + lock was obtained; otherwise it returns \c false. If another thread has locked for writing, this function will wait for at most \a timeout milliseconds for the lock to become available. @@ -309,7 +309,7 @@ void QReadWriteLock::lockForWrite() /*! Attempts to lock for writing. If the lock was obtained, this - function returns true; otherwise, it returns false immediately. + function returns \c true; otherwise, it returns \c false immediately. The lock attempt will fail if another thread has locked for reading or writing. @@ -352,8 +352,8 @@ bool QReadWriteLock::tryLockForWrite() /*! \overload - Attempts to lock for writing. This function returns true if the - lock was obtained; otherwise it returns false. If another thread + Attempts to lock for writing. This function returns \c true if the + lock was obtained; otherwise it returns \c false. If another thread has locked for reading or writing, this function will wait for at most \a timeout milliseconds for the lock to become available. |