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>

1 files changed, 18 insertions, 18 deletions

diff --git a/src/corelib/tools/qmap.cpp b/src/corelib/tools/qmap.cpp
index 01a6a22631..ab9b1d23ab 100644
--- a/src/corelib/tools/qmap.cpp
+++ b/src/corelib/tools/qmap.cpp
@@ -600,7 +600,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn bool QMap::operator==(const QMap<Key, T> &other) const
 
-    Returns true if \a other is equal to this map; otherwise returns
+    Returns \c true if \a other is equal to this map; otherwise returns
     false.
 
     Two maps are considered equal if they contain the same (key,
@@ -614,8 +614,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn bool QMap::operator!=(const QMap<Key, T> &other) const
 
-    Returns true if \a other is not equal to this map; otherwise
-    returns false.
+    Returns \c true if \a other is not equal to this map; otherwise
+    returns \c false.
 
     Two maps are considered equal if they contain the same (key,
     value) pairs.
@@ -636,7 +636,7 @@ void QMapDataBase::freeData(QMapDataBase *d)
 /*!
     \fn bool QMap::isEmpty() const
 
-    Returns true if the map contains no items; otherwise returns
+    Returns \c true if the map contains no items; otherwise returns
     false.
 
     \sa size()
@@ -656,8 +656,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
     \internal
 
-    Returns true if the map's internal data isn't shared with any
-    other map object; otherwise returns false.
+    Returns \c true if the map's internal data isn't shared with any
+    other map object; otherwise returns \c false.
 
     \sa detach()
 */
@@ -706,8 +706,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn bool QMap::contains(const Key &key) const
 
-    Returns true if the map contains an item with key \a key;
-    otherwise returns false.
+    Returns \c true if the map contains an item with key \a key;
+    otherwise returns \c false.
 
     \sa count(), QMultiMap::contains()
 */
@@ -1303,8 +1303,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
     \fn bool QMap::iterator::operator==(const iterator &other) const
     \fn bool QMap::iterator::operator==(const const_iterator &other) const
 
-    Returns true if \a other points to the same item as this
-    iterator; otherwise returns false.
+    Returns \c true if \a other points to the same item as this
+    iterator; otherwise returns \c false.
 
     \sa operator!=()
 */
@@ -1313,8 +1313,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
     \fn bool QMap::iterator::operator!=(const iterator &other) const
     \fn bool QMap::iterator::operator!=(const const_iterator &other) const
 
-    Returns true if \a other points to a different item than this
-    iterator; otherwise returns false.
+    Returns \c true if \a other points to a different item than this
+    iterator; otherwise returns \c false.
 
     \sa operator==()
 */
@@ -1515,16 +1515,16 @@ void QMapDataBase::freeData(QMapDataBase *d)
 
 /*! \fn bool QMap::const_iterator::operator==(const const_iterator &other) const
 
-    Returns true if \a other points to the same item as this
-    iterator; otherwise returns false.
+    Returns \c true if \a other points to the same item as this
+    iterator; otherwise returns \c false.
 
     \sa operator!=()
 */
 
 /*! \fn bool QMap::const_iterator::operator!=(const const_iterator &other) const
 
-    Returns true if \a other points to a different item than this
-    iterator; otherwise returns false.
+    Returns \c true if \a other points to a different item than this
+    iterator; otherwise returns \c false.
 
     \sa operator==()
 */
@@ -1772,8 +1772,8 @@ void QMapDataBase::freeData(QMapDataBase *d)
     \fn bool QMultiMap::contains(const Key &key, const T &value) const
     \since 4.3
 
-    Returns true if the map contains an item with key \a key and
-    value \a value; otherwise returns false.
+    Returns \c true if the map contains an item with key \a key and
+    value \a value; otherwise returns \c false.
 
     \sa QMap::contains()
 */