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, 24 insertions, 24 deletions

diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp
index a9ba4aaaad..f74c592e8c 100644
--- a/src/corelib/kernel/qmetatype.cpp
+++ b/src/corelib/kernel/qmetatype.cpp
@@ -331,7 +331,7 @@ struct DefinedTypesFilter {
     \fn bool QMetaType::isValid() const
     \since 5.0
 
-    Returns true if this QMetaType object contains valid
+    Returns \c true if this QMetaType object contains valid
     information about a type, false otherwise.
 */
 
@@ -339,7 +339,7 @@ struct DefinedTypesFilter {
     \fn bool QMetaType::isRegistered() const
     \since 5.0
 
-    Returns true if this QMetaType object contains valid
+    Returns \c true if this QMetaType object contains valid
     information about a type, false otherwise.
 */
 
@@ -540,7 +540,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
     \fn bool QMetaType::registerConverter()
     \since 5.2
     Registers the possibility of an implicit conversion from type From to type To in the meta
-    type system. Returns true if the registration succeeded, otherwise false.
+    type system. Returns \c true if the registration succeeded, otherwise false.
 */
 
 /*!
@@ -548,7 +548,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
     \since 5.2
     \overload
     Registers a method \a function like To From::function() const as converter from type From
-    to type To in the meta type system. Returns true if the registration succeeded, otherwise false.
+    to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
 */
 
 /*!
@@ -556,7 +556,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
     \since 5.2
     \overload
     Registers a method \a function like To From::function(bool *ok) const as converter from type From
-    to type To in the meta type system. Returns true if the registration succeeded, otherwise false.
+    to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
 */
 
 /*!
@@ -564,7 +564,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
     \since 5.2
     \overload
     Registers a unary function object \a function as converter from type From
-    to type To in the meta type system. Returns true if the registration succeeded, otherwise false.
+    to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false.
 */
 
 /*!
@@ -572,7 +572,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
     \since 5.2
     Registers comparison operetarors for the user-registered type T. This requires T to have
     both an operator== and an operator<.
-    Returns true if the registration succeeded, otherwise false.
+    Returns \c true if the registration succeeded, otherwise false.
 */
 
 #ifndef QT_NO_DEBUG_STREAM
@@ -580,14 +580,14 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry)
     \fn bool QMetaType::registerDebugStreamOperator()
     Registers the debug stream operator for the user-registered type T. This requires T to have
     an operator<<(QDebug dbg, T).
-    Returns true if the registration succeeded, otherwise false.
+    Returns \c true if the registration succeeded, otherwise false.
 */
 #endif
 
 /*!
     Registers function \a f as converter function from type id \a from to \a to.
     If there's already a conversion registered, this does nothing but deleting \a f.
-    Returns true if the registration succeeded, otherwise false.
+    Returns \c true if the registration succeeded, otherwise false.
     \since 5.2
     \internal
 */
@@ -624,12 +624,12 @@ bool QMetaType::registerComparatorFunction(const QtPrivate::AbstractComparatorFu
 
 /*!
     \fn bool QMetaType::hasRegisteredComparators()
-    Returns true, if the meta type system has registered comparators for type T.
+    Returns \c true, if the meta type system has registered comparators for type T.
     \since 5.2
  */
 
 /*!
-    Returns true, if the meta type system has registered comparators for type id \a typeId.
+    Returns \c true, if the meta type system has registered comparators for type id \a typeId.
     \since 5.2
  */
 bool QMetaType::hasRegisteredComparators(int typeId)
@@ -650,12 +650,12 @@ bool QMetaType::registerDebugStreamOperatorFunction(const QtPrivate::AbstractDeb
 
 /*!
     \fn bool QMetaType::hasRegisteredDebugStreamOperator()
-    Returns true, if the meta type system has a registered debug stream operator for type T.
+    Returns \c true, if the meta type system has a registered debug stream operator for type T.
     \since 5.2
  */
 
 /*!
-    Returns true, if the meta type system has a registered debug stream operator for type
+    Returns \c true, if the meta type system has a registered debug stream operator for type
     id \a typeId.
     \since 5.2
 */
@@ -667,7 +667,7 @@ bool QMetaType::hasRegisteredDebugStreamOperator(int typeId)
 
 /*!
     Converts the object at \a from from \a fromTypeId to the preallocated space at \a to
-    typed \a toTypeId. Returns true, if the conversion succeeded, otherwise false.
+    typed \a toTypeId. Returns \c true, if the conversion succeeded, otherwise false.
     \since 5.2
 */
 bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId)
@@ -680,7 +680,7 @@ bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId
 /*!
     Compares the objects at \a lhs and \a rhs. Both objects need to be of type \a typeId.
     \a result is set to less than, equal to or greater than zero, if \a lhs is less than, equal to
-    or greater than \a rhs. Returns true, if the comparison succeeded, otherwiess false.
+    or greater than \a rhs. Returns \c true, if the comparison succeeded, otherwiess false.
     \since 5.2
 */
 bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int* result)
@@ -697,7 +697,7 @@ bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int* resul
 }
 
 /*!
-    Streams the object at \a rhs of type \a typeId to the debug stream \a dbg. Returns true
+    Streams the object at \a rhs of type \a typeId to the debug stream \a dbg. Returns \c true
     on success, otherwise false.
     \since 5.2
 */
@@ -712,13 +712,13 @@ bool QMetaType::debugStream(QDebug& dbg, const void *rhs, int typeId)
 
 /*!
     \fn bool QMetaType::hasRegisteredConverterFunction()
-    Returns true, if the meta type system has a registered conversion from type From to type To.
+    Returns \c true, if the meta type system has a registered conversion from type From to type To.
     \since 5.2
     \overload
     */
 
 /*!
-    Returns true, if the meta type system has a registered conversion from meta type id \a fromTypeId
+    Returns \c true, if the meta type system has a registered conversion from meta type id \a fromTypeId
     to \a toTypeId
     \since 5.2
 */
@@ -1027,8 +1027,8 @@ int QMetaType::registerNormalizedTypedef(const NS(QByteArray) &normalizedTypeNam
 }
 
 /*!
-    Returns true if the datatype with ID \a type is registered;
-    otherwise returns false.
+    Returns \c true if the datatype with ID \a type is registered;
+    otherwise returns \c false.
 
     \sa type(), typeName(), Type
 */
@@ -1103,8 +1103,8 @@ int qMetaTypeTypeInternal(const char *typeName)
 #ifndef QT_NO_DATASTREAM
 /*!
     Writes the object pointed to by \a data with the ID \a type to
-    the given \a stream. Returns true if the object is saved
-    successfully; otherwise returns false.
+    the given \a stream. Returns \c true if the object is saved
+    successfully; otherwise returns \c false.
 
     The type must have been registered with qRegisterMetaType() and
     qRegisterMetaTypeStreamOperators() beforehand.
@@ -1320,8 +1320,8 @@ bool QMetaType::save(QDataStream &stream, int type, const void *data)
 
 /*!
     Reads the object of the specified \a type from the given \a
-    stream into \a data. Returns true if the object is loaded
-    successfully; otherwise returns false.
+    stream into \a data. Returns \c true if the object is loaded
+    successfully; otherwise returns \c false.
 
     The type must have been registered with qRegisterMetaType() and
     qRegisterMetaTypeStreamOperators() beforehand.