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/global/qglobalstatic.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/global/qglobalstatic.cpp')
-rw-r--r-- | src/corelib/global/qglobalstatic.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/corelib/global/qglobalstatic.cpp b/src/corelib/global/qglobalstatic.cpp index 8474d132b4..35069f5a21 100644 --- a/src/corelib/global/qglobalstatic.cpp +++ b/src/corelib/global/qglobalstatic.cpp @@ -270,8 +270,8 @@ earlier versions. They could be used again in the future. The QGlobalStatic::exists() and QGlobalStatic::isDestroyed() functions - operate solely on the guard variable: the former returns true if the guard - is negative, whereas the latter returns true only if it is -2. + operate solely on the guard variable: the former returns \c true if the guard + is negative, whereas the latter returns \c true only if it is -2. The Q_GLOBAL_STATIC_INTERNAL macro implements the actual construction and destruction. There are two implementations of it: one for compilers that @@ -374,9 +374,9 @@ /*! \fn bool QGlobalStatic::isDestroyed() const - This function returns true if the global static object has already + This function returns \c true if the global static object has already completed destruction (that is, if the destructor for the type has already - returned). In specific, note that this function returns false if + returned). In specific, note that this function returns \c false if the destruction is still in progress. Once this function has returned true once, it will never return @@ -404,9 +404,9 @@ /*! \fn bool QGlobalStatic::exists() const - This function returns true if the global static object has already + This function returns \c true if the global static object has already completed initialization (that is, if the constructor for the type has - already returned). In specific, note that this function returns false if + already returned). In specific, note that this function returns \c false if the initialization is still in progress. Once this function has returned true once, it will never return false again |