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>

5 files changed, 18 insertions, 18 deletions

diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp
index e2b1502a8e..ff2c4bbe5e 100644
--- a/src/corelib/global/qglobal.cpp
+++ b/src/corelib/global/qglobal.cpp
@@ -346,15 +346,15 @@ Q_CORE_EXPORT void *qMemSet(void *dest, int c, size_t n);
 /*!
     \fn bool QFlags::operator!() const
 
-    Returns true if no flag is set (i.e., if the value stored by the
-    QFlags object is 0); otherwise returns false.
+    Returns \c true if no flag is set (i.e., if the value stored by the
+    QFlags object is 0); otherwise returns \c false.
 */
 
 /*!
     \fn bool QFlags::testFlag(Enum flag) const
     \since 4.2
 
-    Returns true if the \a flag is set, otherwise false.
+    Returns \c true if the \a flag is set, otherwise false.
 */
 
 /*!
@@ -2295,7 +2295,7 @@ bool qputenv(const char *varName, const QByteArray& value)
 
     This function deletes the variable \a varName from the environment.
 
-    Returns true on success.
+    Returns \c true on success.
 
     \since 5.1
 
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
diff --git a/src/corelib/global/qlibraryinfo.cpp b/src/corelib/global/qlibraryinfo.cpp
index 61841cab76..8d681f0c4c 100644
--- a/src/corelib/global/qlibraryinfo.cpp
+++ b/src/corelib/global/qlibraryinfo.cpp
@@ -253,7 +253,7 @@ QLibraryInfo::buildDate()
 
 /*!
     \since 5.0
-    Returns true if this build of Qt was built with debugging enabled, or
+    Returns \c true if this build of Qt was built with debugging enabled, or
     false if it was built in release mode.
 */
 bool
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index 1cd2321ef6..f46640ea0e 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -2234,7 +2234,7 @@
         of rich text.
 
     \value AutoText The text string is interpreted as for
-        Qt::RichText if Qt::mightBeRichText() returns true, otherwise
+        Qt::RichText if Qt::mightBeRichText() returns \c true, otherwise
         as Qt::PlainText.
 */
 
diff --git a/src/corelib/global/qnumeric.cpp b/src/corelib/global/qnumeric.cpp
index 5e71753c8a..d09357c26c 100644
--- a/src/corelib/global/qnumeric.cpp
+++ b/src/corelib/global/qnumeric.cpp
@@ -45,37 +45,37 @@
 QT_BEGIN_NAMESPACE
 
 /*!
-    Returns true if the double \a {d} is equivalent to infinity.
+    Returns \c true if the double \a {d} is equivalent to infinity.
     \relates <QtGlobal>
 */
 Q_CORE_EXPORT bool qIsInf(double d) { return qt_is_inf(d); }
 
 /*!
-    Returns true if the double \a {d} is not a number (NaN).
+    Returns \c true if the double \a {d} is not a number (NaN).
     \relates <QtGlobal>
 */
 Q_CORE_EXPORT bool qIsNaN(double d) { return qt_is_nan(d); }
 
 /*!
-    Returns true if the double \a {d} is a finite number.
+    Returns \c true if the double \a {d} is a finite number.
     \relates <QtGlobal>
 */
 Q_CORE_EXPORT bool qIsFinite(double d) { return qt_is_finite(d); }
 
 /*!
-    Returns true if the float \a {f} is equivalent to infinity.
+    Returns \c true if the float \a {f} is equivalent to infinity.
     \relates <QtGlobal>
 */
 Q_CORE_EXPORT bool qIsInf(float f) { return qt_is_inf(f); }
 
 /*!
-    Returns true if the float \a {f} is not a number (NaN).
+    Returns \c true if the float \a {f} is not a number (NaN).
     \relates <QtGlobal>
 */
 Q_CORE_EXPORT bool qIsNaN(float f) { return qt_is_nan(f); }
 
 /*!
-    Returns true if the float \a {f} is a finite number.
+    Returns \c true if the float \a {f} is a finite number.
     \relates <QtGlobal>
 */
 Q_CORE_EXPORT bool qIsFinite(float f) { return qt_is_finite(f); }