From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/corelib/tools/qalgorithms.qdoc | 6 +- src/corelib/tools/qbitarray.cpp | 18 +- src/corelib/tools/qbytearray.cpp | 140 +++++++-------- src/corelib/tools/qcache.qdoc | 16 +- src/corelib/tools/qchar.cpp | 142 ++++++++-------- src/corelib/tools/qcollator.cpp | 8 +- src/corelib/tools/qcommandlineparser.cpp | 16 +- src/corelib/tools/qcontiguouscache.cpp | 12 +- src/corelib/tools/qcryptographichash.cpp | 2 +- src/corelib/tools/qdatetime.cpp | 96 +++++------ src/corelib/tools/qdatetimeparser.cpp | 6 +- src/corelib/tools/qeasingcurve.cpp | 4 +- src/corelib/tools/qelapsedtimer.cpp | 8 +- src/corelib/tools/qelapsedtimer_generic.cpp | 4 +- src/corelib/tools/qhash.cpp | 38 ++--- src/corelib/tools/qiterator.qdoc | 28 +-- src/corelib/tools/qline.cpp | 16 +- src/corelib/tools/qlinkedlist.cpp | 42 ++--- src/corelib/tools/qlist.cpp | 56 +++--- src/corelib/tools/qlocale.qdoc | 8 +- src/corelib/tools/qmap.cpp | 36 ++-- src/corelib/tools/qmargins.cpp | 8 +- src/corelib/tools/qmessageauthenticationcode.cpp | 2 +- src/corelib/tools/qpair.qdoc | 16 +- src/corelib/tools/qpoint.cpp | 20 +-- src/corelib/tools/qrect.cpp | 84 ++++----- src/corelib/tools/qregexp.cpp | 28 +-- src/corelib/tools/qregularexpression.cpp | 22 +-- src/corelib/tools/qscopedpointer.cpp | 8 +- src/corelib/tools/qset.qdoc | 32 ++-- src/corelib/tools/qshareddata.cpp | 18 +- src/corelib/tools/qsharedpointer.cpp | 32 ++-- src/corelib/tools/qsize.cpp | 38 ++--- src/corelib/tools/qstring.cpp | 208 +++++++++++------------ src/corelib/tools/qstringlist.cpp | 4 +- src/corelib/tools/qtextboundaryfinder.cpp | 4 +- src/corelib/tools/qtimezone.cpp | 14 +- src/corelib/tools/qvarlengtharray.qdoc | 6 +- src/corelib/tools/qvector.cpp | 24 +-- 39 files changed, 635 insertions(+), 635 deletions(-) (limited to 'src/corelib/tools') diff --git a/src/corelib/tools/qalgorithms.qdoc b/src/corelib/tools/qalgorithms.qdoc index fce65b9a87..4eb7a170dc 100644 --- a/src/corelib/tools/qalgorithms.qdoc +++ b/src/corelib/tools/qalgorithms.qdoc @@ -139,7 +139,7 @@ \row \li \c{i - n} \li returns the iterator for the item \c n positions behind of iterator \c i \row \li \c{i - j} \li returns the number of items between iterators \c i and \c j \row \li \c{i[n]} \li same as \c{*(i + n)} - \row \li \c{i < j} \li returns true if iterator \c j comes after iterator \c i + \row \li \c{i < j} \li returns \c true if iterator \c j comes after iterator \c i \endtable QList and QVector's non-const iterator types are random access iterators. @@ -273,8 +273,8 @@ Use std::equal instead. Compares the items in the range [\a begin1, \a end1) with the - items in the range [\a begin2, ...). Returns true if all the - items compare equal; otherwise returns false. + items in the range [\a begin2, ...). Returns \c true if all the + items compare equal; otherwise returns \c false. Example: \snippet code/doc_src_qalgorithms.cpp 6 diff --git a/src/corelib/tools/qbitarray.cpp b/src/corelib/tools/qbitarray.cpp index 4f1fce3077..f583444d3c 100644 --- a/src/corelib/tools/qbitarray.cpp +++ b/src/corelib/tools/qbitarray.cpp @@ -262,7 +262,7 @@ void QBitArray::resize(int size) /*! \fn bool QBitArray::isEmpty() const - Returns true if this bit array has size 0; otherwise returns + Returns \c true if this bit array has size 0; otherwise returns false. \sa size() @@ -270,7 +270,7 @@ void QBitArray::resize(int size) /*! \fn bool QBitArray::isNull() const - Returns true if this bit array is null; otherwise returns false. + Returns \c true if this bit array is null; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qbitarray.cpp 5 @@ -286,7 +286,7 @@ void QBitArray::resize(int size) /*! \fn bool QBitArray::fill(bool value, int size = -1) Sets every bit in the bit array to \a value, returning true if successful; - otherwise returns false. If \a size is different from -1 (the default), + otherwise returns \c false. If \a size is different from -1 (the default), the bit array is resized to \a size beforehand. Example: @@ -363,8 +363,8 @@ void QBitArray::fill(bool value, int begin, int end) /*! \fn bool QBitArray::testBit(int i) const - Returns true if the bit at index position \a i is 1; otherwise - returns false. + Returns \c true if the bit at index position \a i is 1; otherwise + returns \c false. \a i must be a valid index position in the bit array (i.e., 0 <= \a i < size()). @@ -478,16 +478,16 @@ void QBitArray::fill(bool value, int begin, int end) /*! \fn bool QBitArray::operator==(const QBitArray &other) const - Returns true if \a other is equal to this bit array; otherwise - returns false. + Returns \c true if \a other is equal to this bit array; otherwise + returns \c false. \sa operator!=() */ /*! \fn bool QBitArray::operator!=(const QBitArray &other) const - Returns true if \a other is not equal to this bit array; - otherwise returns false. + Returns \c true if \a other is not equal to this bit array; + otherwise returns \c false. \sa operator==() */ diff --git a/src/corelib/tools/qbytearray.cpp b/src/corelib/tools/qbytearray.cpp index 92d0d30f54..eb06bd4713 100644 --- a/src/corelib/tools/qbytearray.cpp +++ b/src/corelib/tools/qbytearray.cpp @@ -1009,7 +1009,7 @@ QByteArray &QByteArray::operator=(const char *str) /*! \fn bool QByteArray::isEmpty() const - Returns true if the byte array has size 0; otherwise returns false. + Returns \c true if the byte array has size 0; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qbytearray.cpp 7 @@ -1212,8 +1212,8 @@ QByteArray &QByteArray::operator=(const char *str) /*! \fn bool QByteArray::contains(const QByteArray &ba) const - Returns true if the byte array contains an occurrence of the byte - array \a ba; otherwise returns false. + Returns \c true if the byte array contains an occurrence of the byte + array \a ba; otherwise returns \c false. \sa indexOf(), count() */ @@ -1222,16 +1222,16 @@ QByteArray &QByteArray::operator=(const char *str) \overload - Returns true if the byte array contains the string \a str; - otherwise returns false. + Returns \c true if the byte array contains the string \a str; + otherwise returns \c false. */ /*! \fn bool QByteArray::contains(char ch) const \overload - Returns true if the byte array contains the character \a ch; - otherwise returns false. + Returns \c true if the byte array contains the character \a ch; + otherwise returns \c false. */ /*! @@ -1334,7 +1334,7 @@ void QByteArray::chop(int n) /*! \fn bool QByteArray::isNull() const - Returns true if this byte array is null; otherwise returns false. + Returns \c true if this byte array is null; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qbytearray.cpp 13 @@ -2534,8 +2534,8 @@ int QByteArray::count(char ch) const */ /*! - Returns true if this byte array starts with byte array \a ba; - otherwise returns false. + Returns \c true if this byte array starts with byte array \a ba; + otherwise returns \c false. Example: \snippet code/src_corelib_tools_qbytearray.cpp 25 @@ -2553,8 +2553,8 @@ bool QByteArray::startsWith(const QByteArray &ba) const /*! \overload - Returns true if this byte array starts with string \a str; - otherwise returns false. + Returns \c true if this byte array starts with string \a str; + otherwise returns \c false. */ bool QByteArray::startsWith(const char *str) const { @@ -2568,8 +2568,8 @@ bool QByteArray::startsWith(const char *str) const /*! \overload - Returns true if this byte array starts with character \a ch; - otherwise returns false. + Returns \c true if this byte array starts with character \a ch; + otherwise returns \c false. */ bool QByteArray::startsWith(char ch) const { @@ -2579,8 +2579,8 @@ bool QByteArray::startsWith(char ch) const } /*! - Returns true if this byte array ends with byte array \a ba; - otherwise returns false. + Returns \c true if this byte array ends with byte array \a ba; + otherwise returns \c false. Example: \snippet code/src_corelib_tools_qbytearray.cpp 26 @@ -2598,8 +2598,8 @@ bool QByteArray::endsWith(const QByteArray &ba) const /*! \overload - Returns true if this byte array ends with string \a str; otherwise - returns false. + Returns \c true if this byte array ends with string \a str; otherwise + returns \c false. */ bool QByteArray::endsWith(const char *str) const { @@ -2613,8 +2613,8 @@ bool QByteArray::endsWith(const char *str) const /*! \overload - Returns true if this byte array ends with character \a ch; - otherwise returns false. + Returns \c true if this byte array ends with character \a ch; + otherwise returns \c false. */ bool QByteArray::endsWith(char ch) const { @@ -2812,8 +2812,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) /*! \fn bool QByteArray::operator==(const QString &str) const - Returns true if this byte array is equal to string \a str; - otherwise returns false. + Returns \c true if this byte array is equal to string \a str; + otherwise returns \c false. The Unicode data is converted into 8-bit characters using QString::toUtf8(). @@ -2829,8 +2829,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) /*! \fn bool QByteArray::operator!=(const QString &str) const - Returns true if this byte array is not equal to string \a str; - otherwise returns false. + Returns \c true if this byte array is not equal to string \a str; + otherwise returns \c false. The Unicode data is converted into 8-bit characters using QString::toUtf8(). @@ -2846,8 +2846,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) /*! \fn bool QByteArray::operator<(const QString &str) const - Returns true if this byte array is lexically less than string \a - str; otherwise returns false. + Returns \c true if this byte array is lexically less than string \a + str; otherwise returns \c false. The Unicode data is converted into 8-bit characters using QString::toUtf8(). @@ -2863,8 +2863,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) /*! \fn bool QByteArray::operator>(const QString &str) const - Returns true if this byte array is lexically greater than string - \a str; otherwise returns false. + Returns \c true if this byte array is lexically greater than string + \a str; otherwise returns \c false. The Unicode data is converted into 8-bit characters using QString::toUtf8(). @@ -2880,8 +2880,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) /*! \fn bool QByteArray::operator<=(const QString &str) const - Returns true if this byte array is lexically less than or equal - to string \a str; otherwise returns false. + Returns \c true if this byte array is lexically less than or equal + to string \a str; otherwise returns \c false. The Unicode data is converted into 8-bit characters using QString::toUtf8(). @@ -2897,8 +2897,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) /*! \fn bool QByteArray::operator>=(const QString &str) const - Returns true if this byte array is greater than or equal to string - \a str; otherwise returns false. + Returns \c true if this byte array is greater than or equal to string + \a str; otherwise returns \c false. The Unicode data is converted into 8-bit characters using QString::toUtf8(). @@ -2917,8 +2917,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is equal to byte array \a a2; - otherwise returns false. + Returns \c true if byte array \a a1 is equal to byte array \a a2; + otherwise returns \c false. */ /*! \fn bool operator==(const QByteArray &a1, const char *a2) @@ -2926,8 +2926,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is equal to string \a a2; - otherwise returns false. + Returns \c true if byte array \a a1 is equal to string \a a2; + otherwise returns \c false. */ /*! \fn bool operator==(const char *a1, const QByteArray &a2) @@ -2935,8 +2935,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if string \a a1 is equal to byte array \a a2; - otherwise returns false. + Returns \c true if string \a a1 is equal to byte array \a a2; + otherwise returns \c false. */ /*! \fn bool operator!=(const QByteArray &a1, const QByteArray &a2) @@ -2944,8 +2944,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is not equal to byte array \a a2; - otherwise returns false. + Returns \c true if byte array \a a1 is not equal to byte array \a a2; + otherwise returns \c false. */ /*! \fn bool operator!=(const QByteArray &a1, const char *a2) @@ -2953,8 +2953,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is not equal to string \a a2; - otherwise returns false. + Returns \c true if byte array \a a1 is not equal to string \a a2; + otherwise returns \c false. */ /*! \fn bool operator!=(const char *a1, const QByteArray &a2) @@ -2962,8 +2962,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if string \a a1 is not equal to byte array \a a2; - otherwise returns false. + Returns \c true if string \a a1 is not equal to byte array \a a2; + otherwise returns \c false. */ /*! \fn bool operator<(const QByteArray &a1, const QByteArray &a2) @@ -2971,8 +2971,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically less than byte array - \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically less than byte array + \a a2; otherwise returns \c false. */ /*! \fn inline bool operator<(const QByteArray &a1, const char *a2) @@ -2980,8 +2980,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically less than string - \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically less than string + \a a2; otherwise returns \c false. */ /*! \fn bool operator<(const char *a1, const QByteArray &a2) @@ -2989,8 +2989,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if string \a a1 is lexically less than byte array - \a a2; otherwise returns false. + Returns \c true if string \a a1 is lexically less than byte array + \a a2; otherwise returns \c false. */ /*! \fn bool operator<=(const QByteArray &a1, const QByteArray &a2) @@ -2998,8 +2998,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically less than or equal - to byte array \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically less than or equal + to byte array \a a2; otherwise returns \c false. */ /*! \fn bool operator<=(const QByteArray &a1, const char *a2) @@ -3007,8 +3007,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically less than or equal - to string \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically less than or equal + to string \a a2; otherwise returns \c false. */ /*! \fn bool operator<=(const char *a1, const QByteArray &a2) @@ -3016,8 +3016,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if string \a a1 is lexically less than or equal - to byte array \a a2; otherwise returns false. + Returns \c true if string \a a1 is lexically less than or equal + to byte array \a a2; otherwise returns \c false. */ /*! \fn bool operator>(const QByteArray &a1, const QByteArray &a2) @@ -3025,8 +3025,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically greater than byte - array \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically greater than byte + array \a a2; otherwise returns \c false. */ /*! \fn bool operator>(const QByteArray &a1, const char *a2) @@ -3034,8 +3034,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically greater than string - \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically greater than string + \a a2; otherwise returns \c false. */ /*! \fn bool operator>(const char *a1, const QByteArray &a2) @@ -3043,8 +3043,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if string \a a1 is lexically greater than byte array - \a a2; otherwise returns false. + Returns \c true if string \a a1 is lexically greater than byte array + \a a2; otherwise returns \c false. */ /*! \fn bool operator>=(const QByteArray &a1, const QByteArray &a2) @@ -3052,8 +3052,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically greater than or - equal to byte array \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically greater than or + equal to byte array \a a2; otherwise returns \c false. */ /*! \fn bool operator>=(const QByteArray &a1, const char *a2) @@ -3061,8 +3061,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if byte array \a a1 is lexically greater than or - equal to string \a a2; otherwise returns false. + Returns \c true if byte array \a a1 is lexically greater than or + equal to string \a a2; otherwise returns \c false. */ /*! \fn bool operator>=(const char *a1, const QByteArray &a2) @@ -3070,8 +3070,8 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) \overload - Returns true if string \a a1 is lexically greater than or - equal to byte array \a a2; otherwise returns false. + Returns \c true if string \a a1 is lexically greater than or + equal to byte array \a a2; otherwise returns \c false. */ /*! \fn const QByteArray operator+(const QByteArray &a1, const QByteArray &a2) @@ -3125,7 +3125,7 @@ QDataStream &operator>>(QDataStream &in, QByteArray &ba) replaced with a single space. Whitespace means any character for which the standard C++ - isspace() function returns true. This includes the ASCII + isspace() function returns \c true. This includes the ASCII characters '\\t', '\\n', '\\v', '\\f', '\\r', and ' '. Example: @@ -3163,7 +3163,7 @@ QByteArray QByteArray::simplified() const and the end. Whitespace means any character for which the standard C++ - isspace() function returns true. This includes the ASCII + isspace() function returns \c true. This includes the ASCII characters '\\t', '\\n', '\\v', '\\f', '\\r', and ' '. Example: diff --git a/src/corelib/tools/qcache.qdoc b/src/corelib/tools/qcache.qdoc index 4d19d671fd..6d8bf4da59 100644 --- a/src/corelib/tools/qcache.qdoc +++ b/src/corelib/tools/qcache.qdoc @@ -134,8 +134,8 @@ /*! \fn bool QCache::isEmpty() const - Returns true if the cache contains no objects; otherwise - returns false. + Returns \c true if the cache contains no objects; otherwise + returns \c false. \sa size() */ @@ -163,8 +163,8 @@ deleted at any time. In particular, if \a cost is greater than maxCost(), the object will be deleted immediately. - The function returns true if the object was inserted into the - cache; otherwise it returns false. + The function returns \c true if the object was inserted into the + cache; otherwise it returns \c false. \sa take(), remove() */ @@ -182,8 +182,8 @@ /*! \fn bool QCache::contains(const Key &key) const - Returns true if the cache contains an object associated with key \a - key; otherwise returns false. + Returns \c true if the cache contains an object associated with key \a + key; otherwise returns \c false. \sa take(), remove() */ @@ -201,8 +201,8 @@ /*! \fn bool QCache::remove(const Key &key) - Deletes the object associated with key \a key. Returns true if the - object was found in the cache; otherwise returns false. + Deletes the object associated with key \a key. Returns \c true if the + object was found in the cache; otherwise returns \c false. \sa take(), clear() */ diff --git a/src/corelib/tools/qchar.cpp b/src/corelib/tools/qchar.cpp index d99bba93ee..4ed0cd5eea 100644 --- a/src/corelib/tools/qchar.cpp +++ b/src/corelib/tools/qchar.cpp @@ -115,7 +115,7 @@ QT_BEGIN_NAMESPACE operating on the full range of Unicode characters, not just for the ASCII range. They all return true if the character is a certain type of character; otherwise they return false. These classification functions are - isNull() (returns true if the character is '\\0'), isPrint() + isNull() (returns \c true if the character is '\\0'), isPrint() (true if the character is any sort of printable character, including whitespace), isPunct() (any sort of punctation), isMark() (Unicode Mark), isLetter() (a letter), isNumber() (any @@ -123,7 +123,7 @@ QT_BEGIN_NAMESPACE isDigit() (decimal digits). All of these are wrappers around category() which return the Unicode-defined category of each character. Some of these also calculate the derived properties - (for example isSpace() returns true if the character is of category + (for example isSpace() returns \c true if the character is of category Separator_* or an exceptional code point from Other_Control category). QChar also provides direction(), which indicates the "natural" @@ -597,8 +597,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QChar::isNull() const - Returns true if the character is the Unicode character 0x0000 - ('\\0'); otherwise returns false. + Returns \c true if the character is the Unicode character 0x0000 + ('\\0'); otherwise returns \c false. */ /*! @@ -620,8 +620,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QChar::isPrint() const - Returns true if the character is a printable character; otherwise - returns false. This is any character not of category Other_*. + Returns \c true if the character is a printable character; otherwise + returns \c false. This is any character not of category Other_*. Note that this gives no indication of whether the character is available in a particular font. @@ -631,8 +631,8 @@ QT_BEGIN_NAMESPACE \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a printable character; otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a printable character; otherwise returns \c false. This is any character not of category Other_*. Note that this gives no indication of whether the character is @@ -653,9 +653,9 @@ bool QChar::isPrint(uint ucs4) /*! \fn bool QChar::isSpace() const - Returns true if the character is a separator character + Returns \c true if the character is a separator character (Separator_* categories or certain code points from Other_Control category); - otherwise returns false. + otherwise returns \c false. */ /*! @@ -663,9 +663,9 @@ bool QChar::isPrint(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is a separator character (Separator_* categories or certain code points - from Other_Control category); otherwise returns false. + from Other_Control category); otherwise returns \c false. */ /*! @@ -684,8 +684,8 @@ bool QT_FASTCALL QChar::isSpace_helper(uint ucs4) /*! \fn bool QChar::isMark() const - Returns true if the character is a mark (Mark_* categories); - otherwise returns false. + Returns \c true if the character is a mark (Mark_* categories); + otherwise returns \c false. See QChar::Category for more information regarding marks. */ @@ -694,8 +694,8 @@ bool QT_FASTCALL QChar::isSpace_helper(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a mark (Mark_* categories); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a mark (Mark_* categories); otherwise returns \c false. */ bool QChar::isMark(uint ucs4) { @@ -710,16 +710,16 @@ bool QChar::isMark(uint ucs4) /*! \fn bool QChar::isPunct() const - Returns true if the character is a punctuation mark (Punctuation_* - categories); otherwise returns false. + Returns \c true if the character is a punctuation mark (Punctuation_* + categories); otherwise returns \c false. */ /*! \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a punctuation mark (Punctuation_* categories); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a punctuation mark (Punctuation_* categories); otherwise returns \c false. */ bool QChar::isPunct(uint ucs4) { @@ -738,16 +738,16 @@ bool QChar::isPunct(uint ucs4) /*! \fn bool QChar::isSymbol() const - Returns true if the character is a symbol (Symbol_* categories); - otherwise returns false. + Returns \c true if the character is a symbol (Symbol_* categories); + otherwise returns \c false. */ /*! \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a symbol (Symbol_* categories); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a symbol (Symbol_* categories); otherwise returns \c false. */ bool QChar::isSymbol(uint ucs4) { @@ -763,8 +763,8 @@ bool QChar::isSymbol(uint ucs4) /*! \fn bool QChar::isLetter() const - Returns true if the character is a letter (Letter_* categories); - otherwise returns false. + Returns \c true if the character is a letter (Letter_* categories); + otherwise returns \c false. */ /*! @@ -772,8 +772,8 @@ bool QChar::isSymbol(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a letter (Letter_* categories); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a letter (Letter_* categories); otherwise returns \c false. */ /*! @@ -794,8 +794,8 @@ bool QT_FASTCALL QChar::isLetter_helper(uint ucs4) /*! \fn bool QChar::isNumber() const - Returns true if the character is a number (Number_* categories, - not just 0-9); otherwise returns false. + Returns \c true if the character is a number (Number_* categories, + not just 0-9); otherwise returns \c false. \sa isDigit() */ @@ -805,8 +805,8 @@ bool QT_FASTCALL QChar::isLetter_helper(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a number (Number_* categories, not just 0-9); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a number (Number_* categories, not just 0-9); otherwise returns \c false. \sa isDigit() */ @@ -827,8 +827,8 @@ bool QT_FASTCALL QChar::isNumber_helper(uint ucs4) /*! \fn bool QChar::isLetterOrNumber() const - Returns true if the character is a letter or number (Letter_* or - Number_* categories); otherwise returns false. + Returns \c true if the character is a letter or number (Letter_* or + Number_* categories); otherwise returns \c false. */ /*! @@ -836,8 +836,8 @@ bool QT_FASTCALL QChar::isNumber_helper(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a letter or number (Letter_* or Number_* categories); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a letter or number (Letter_* or Number_* categories); otherwise returns \c false. */ /*! @@ -861,8 +861,8 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) /*! \fn bool QChar::isDigit() const - Returns true if the character is a decimal digit - (Number_DecimalDigit); otherwise returns false. + Returns \c true if the character is a decimal digit + (Number_DecimalDigit); otherwise returns \c false. \sa isNumber() */ @@ -872,8 +872,8 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 is - a decimal digit (Number_DecimalDigit); otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is + a decimal digit (Number_DecimalDigit); otherwise returns \c false. \sa isNumber() */ @@ -882,7 +882,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \fn bool QChar::isNonCharacter() const \since 5.0 - Returns true if the QChar is a non-character; false otherwise. + Returns \c true if the QChar is a non-character; false otherwise. Unicode has a certain number of code points that are classified as "non-characters:" that is, they can be used for internal purposes @@ -894,14 +894,14 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) /*! \fn bool QChar::isHighSurrogate() const - Returns true if the QChar is the high part of a UTF16 surrogate + Returns \c true if the QChar is the high part of a UTF16 surrogate (for example if its code point is in range [0xd800..0xdbff]); false otherwise. */ /*! \fn bool QChar::isLowSurrogate() const - Returns true if the QChar is the low part of a UTF16 surrogate + Returns \c true if the QChar is the low part of a UTF16 surrogate (for example if its code point is in range [0xdc00..0xdfff]); false otherwise. */ @@ -909,7 +909,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \fn bool QChar::isSurrogate() const \since 5.0 - Returns true if the QChar contains a code point that is in either + Returns \c true if the QChar contains a code point that is in either the high or the low part of the UTF-16 surrogate range (for example if its code point is in range [0xd800..0xdfff]); false otherwise. */ @@ -919,7 +919,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is a non-character; false otherwise. Unicode has a certain number of code points that are classified @@ -933,7 +933,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \fn static bool QChar::isHighSurrogate(uint ucs4) \overload - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is the high part of a UTF16 surrogate (for example if its code point is in range [0xd800..0xdbff]); false otherwise. */ @@ -942,7 +942,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \fn static bool QChar::isLowSurrogate(uint ucs4) \overload - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is the low part of a UTF16 surrogate (for example if its code point is in range [0xdc00..0xdfff]); false otherwise. */ @@ -952,7 +952,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 contains a code point that is in either the high or the low part of the UTF-16 surrogate range (for example if its code point is in range [0xd800..0xdfff]); false otherwise. @@ -961,7 +961,7 @@ bool QT_FASTCALL QChar::isLetterOrNumber_helper(uint ucs4) /*! \fn static bool QChar::requiresSurrogates(uint ucs4) - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 can be split into the high and low parts of a UTF16 surrogate (for example if its code point is greater than or equals to 0x10000); false otherwise. @@ -1069,8 +1069,8 @@ QChar::Joining QChar::joining(uint ucs4) /*! \fn bool QChar::hasMirrored() const - Returns true if the character should be reversed if the text - direction is reversed; otherwise returns false. + Returns \c true if the character should be reversed if the text + direction is reversed; otherwise returns \c false. A bit faster equivalent of (ch.mirroredChar() != ch). @@ -1081,8 +1081,8 @@ QChar::Joining QChar::joining(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 - should be reversed if the text direction is reversed; otherwise returns false. + Returns \c true if the UCS-4-encoded character specified by \a ucs4 + should be reversed if the text direction is reversed; otherwise returns \c false. A bit faster equivalent of (QChar::mirroredChar(ucs4) != ucs4). @@ -1098,7 +1098,7 @@ bool QChar::hasMirrored(uint ucs4) /*! \fn bool QChar::isLower() const - Returns true if the character is a lowercase letter, for example + Returns \c true if the character is a lowercase letter, for example category() is Letter_Lowercase. \sa isUpper(), toLower(), toUpper() @@ -1109,7 +1109,7 @@ bool QChar::hasMirrored(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is a lowercase letter, for example category() is Letter_Lowercase. \sa isUpper(), toLower(), toUpper() @@ -1118,7 +1118,7 @@ bool QChar::hasMirrored(uint ucs4) /*! \fn bool QChar::isUpper() const - Returns true if the character is an uppercase letter, for example + Returns \c true if the character is an uppercase letter, for example category() is Letter_Uppercase. \sa isLower(), toUpper(), toLower() @@ -1129,7 +1129,7 @@ bool QChar::hasMirrored(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is an uppercase letter, for example category() is Letter_Uppercase. \sa isLower(), toUpper(), toLower() @@ -1138,7 +1138,7 @@ bool QChar::hasMirrored(uint ucs4) /*! \fn bool QChar::isTitleCase() const - Returns true if the character is a titlecase letter, for example + Returns \c true if the character is a titlecase letter, for example category() is Letter_Titlecase. \sa isLower(), toUpper(), toLower(), toTitleCase() @@ -1149,7 +1149,7 @@ bool QChar::hasMirrored(uint ucs4) \overload \since 5.0 - Returns true if the UCS-4-encoded character specified by \a ucs4 + Returns \c true if the UCS-4-encoded character specified by \a ucs4 is a titlecase letter, for example category() is Letter_Titlecase. \sa isLower(), toUpper(), toLower(), toTitleCase() @@ -1586,8 +1586,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr) \relates QChar - Returns true if \a c1 and \a c2 are the same Unicode character; - otherwise returns false. + Returns \c true if \a c1 and \a c2 are the same Unicode character; + otherwise returns \c false. */ /*! @@ -1595,8 +1595,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr) \relates QChar - Returns true if \a c1 and \a c2 are not the same Unicode - character; otherwise returns false. + Returns \c true if \a c1 and \a c2 are not the same Unicode + character; otherwise returns \c false. */ /*! @@ -1604,8 +1604,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr) \relates QChar - Returns true if the numeric Unicode value of \a c1 is less than - or equal to that of \a c2; otherwise returns false. + Returns \c true if the numeric Unicode value of \a c1 is less than + or equal to that of \a c2; otherwise returns \c false. */ /*! @@ -1613,8 +1613,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr) \relates QChar - Returns true if the numeric Unicode value of \a c1 is greater than - or equal to that of \a c2; otherwise returns false. + Returns \c true if the numeric Unicode value of \a c1 is greater than + or equal to that of \a c2; otherwise returns \c false. */ /*! @@ -1622,8 +1622,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr) \relates QChar - Returns true if the numeric Unicode value of \a c1 is less than - that of \a c2; otherwise returns false. + Returns \c true if the numeric Unicode value of \a c1 is less than + that of \a c2; otherwise returns \c false. */ /*! @@ -1631,8 +1631,8 @@ QDataStream &operator>>(QDataStream &in, QChar &chr) \relates QChar - Returns true if the numeric Unicode value of \a c1 is greater than - that of \a c2; otherwise returns false. + Returns \c true if the numeric Unicode value of \a c1 is greater than + that of \a c2; otherwise returns \c false. */ diff --git a/src/corelib/tools/qcollator.cpp b/src/corelib/tools/qcollator.cpp index 7d5915a1cb..a3a9ef940b 100644 --- a/src/corelib/tools/qcollator.cpp +++ b/src/corelib/tools/qcollator.cpp @@ -184,7 +184,7 @@ QLocale QCollator::locale() const /*! \fn bool QCollator::numericMode() const - Returns true if numeric sorting is enabled, false otherwise. + Returns \c true if numeric sorting is enabled, false otherwise. \sa setNumericMode() */ @@ -202,7 +202,7 @@ QLocale QCollator::locale() const /*! \fn bool QCollator::ignorePunctuation() const - Returns true if punctuation characters and symbols are ignored when determining sort order. + Returns \c true if punctuation characters and symbols are ignored when determining sort order. \sa setIgnorePunctuation() */ @@ -303,8 +303,8 @@ QCollatorSortKey& QCollatorSortKey::operator=(const QCollatorSortKey &other) /*! \fn bool QCollatorSortKey::operator<(const QCollatorSortKey &otherKey) const - According to the QCollator that created the key, returns true if the - key should be sorted before than \a otherKey; otherwise returns false. + According to the QCollator that created the key, returns \c true if the + key should be sorted before than \a otherKey; otherwise returns \c false. \sa compare() */ diff --git a/src/corelib/tools/qcommandlineparser.cpp b/src/corelib/tools/qcommandlineparser.cpp index e2e410c059..8054542333 100644 --- a/src/corelib/tools/qcommandlineparser.cpp +++ b/src/corelib/tools/qcommandlineparser.cpp @@ -242,7 +242,7 @@ void QCommandLineParser::setSingleDashWordOptionMode(QCommandLineParser::SingleD /*! Adds the option \a option to look for while parsing. - Returns true if adding the option was successful; otherwise returns false. + Returns \c true if adding the option was successful; otherwise returns \c false. Adding the option fails if there is no name attached to the option, or the option has a name that clashes with an option name added before. @@ -370,7 +370,7 @@ void QCommandLineParser::clearPositionalArguments() Most programs don't need to call this, a simple call to process() is enough. parse() is more low-level, and only does the parsing. The application will have to - take care of the error handling, using errorText() if parse() returns false. + take care of the error handling, using errorText() if parse() returns \c false. This can be useful for instance to show a graphical error message in graphical programs. Calling parse() instead of process() can also be useful in order to ignore unknown @@ -379,7 +379,7 @@ void QCommandLineParser::clearPositionalArguments() Don't forget that \a arguments must start with the name of the executable (ignored, though). - Returns false in case of a parse error (unknown option or missing value); returns true otherwise. + Returns \c false in case of a parse error (unknown option or missing value); returns \c true otherwise. \sa process() */ @@ -390,7 +390,7 @@ bool QCommandLineParser::parse(const QStringList &arguments) /*! Returns a translated error text for the user. - This should only be called when parse() returns false. + This should only be called when parse() returns \c false. */ QString QCommandLineParser::errorText() const { @@ -453,7 +453,7 @@ void QCommandLineParserPrivate::checkParsed(const char *method) /*! \internal Looks up the option \a optionName (found on the command line) and register it as found. - Returns true on success. + Returns \c true on success. */ bool QCommandLineParserPrivate::registerFoundOption(const QString &optionName) { @@ -476,7 +476,7 @@ bool QCommandLineParserPrivate::registerFoundOption(const QString &optionName) \param argument the argument from the command line currently parsed. Only used for -k=value parsing. \param argumentIterator iterator to the currently parsed argument. Incremented if the next argument contains the value. \param argsEnd args.end(), to check if ++argumentIterator goes out of bounds - Returns true on success. + Returns \c true on success. */ bool QCommandLineParserPrivate::parseOptionValue(const QString &optionName, const QString &argument, QStringList::const_iterator *argumentIterator, QStringList::const_iterator argsEnd) @@ -620,7 +620,7 @@ bool QCommandLineParserPrivate::parse(const QStringList &args) /*! Checks whether the option \a name was passed to the application. - Returns true if the option \a name was set, false otherwise. + Returns \c true if the option \a name was set, false otherwise. The name provided can be any long or short name of any option that was added with \c addOption(). All the options names are treated as being @@ -711,7 +711,7 @@ QStringList QCommandLineParser::values(const QString &optionName) const \overload Checks whether the \a option was passed to the application. - Returns true if the \a option was set, false otherwise. + Returns \c true if the \a option was set, false otherwise. This is the recommended way to check for options with no values. diff --git a/src/corelib/tools/qcontiguouscache.cpp b/src/corelib/tools/qcontiguouscache.cpp index 6ccdb7b771..e284ce1e5d 100644 --- a/src/corelib/tools/qcontiguouscache.cpp +++ b/src/corelib/tools/qcontiguouscache.cpp @@ -219,7 +219,7 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::operator==(const QContiguousCache &other) const - Returns true if \a other is equal to this cache; otherwise returns false. + Returns \c true if \a other is equal to this cache; otherwise returns \c false. Two caches are considered equal if they contain the same values at the same indexes. This function requires the value type to implement the \c operator==(). @@ -229,8 +229,8 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::operator!=(const QContiguousCache &other) const - Returns true if \a other is not equal to this cache; otherwise - returns false. + Returns \c true if \a other is not equal to this cache; otherwise + returns \c false. Two caches are considered equal if they contain the same values at the same indexes. This function requires the value type to implement the \c operator==(). @@ -261,14 +261,14 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::isEmpty() const - Returns true if no items are stored within the cache. + Returns \c true if no items are stored within the cache. \sa size(), capacity() */ /*! \fn bool QContiguousCache::isFull() const - Returns true if the number of items stored within the cache is equal + Returns \c true if the number of items stored within the cache is equal to the capacity of the cache. \sa size(), capacity() @@ -373,7 +373,7 @@ MyRecord record(int row) const /*! \fn bool QContiguousCache::containsIndex(int i) const - Returns true if the cache's index range includes the given index \a i. + Returns \c true if the cache's index range includes the given index \a i. \sa firstIndex(), lastIndex() */ diff --git a/src/corelib/tools/qcryptographichash.cpp b/src/corelib/tools/qcryptographichash.cpp index f4f465a623..c425ee7e09 100644 --- a/src/corelib/tools/qcryptographichash.cpp +++ b/src/corelib/tools/qcryptographichash.cpp @@ -326,7 +326,7 @@ void QCryptographicHash::addData(const QByteArray &data) /*! Reads the data from the open QIODevice \a device until it ends - and hashes it. Returns true if reading was successful. + and hashes it. Returns \c true if reading was successful. \since 5.0 */ bool QCryptographicHash::addData(QIODevice* device) diff --git a/src/corelib/tools/qdatetime.cpp b/src/corelib/tools/qdatetime.cpp index 4839560c51..9ddb96b424 100644 --- a/src/corelib/tools/qdatetime.cpp +++ b/src/corelib/tools/qdatetime.cpp @@ -383,7 +383,7 @@ static int fromOffsetString(const QString &offsetString, bool *valid) Constructs a date with year \a y, month \a m and day \a d. If the specified date is invalid, the date is not set and - isValid() returns false. + isValid() returns \c false. \warning Years 1 to 99 are interpreted as is. Year 0 is invalid. @@ -399,7 +399,7 @@ QDate::QDate(int y, int m, int d) /*! \fn bool QDate::isNull() const - Returns true if the date is null; otherwise returns false. A null + Returns \c true if the date is null; otherwise returns \c false. A null date is invalid. \note The behavior of this function is equivalent to isValid(). @@ -411,7 +411,7 @@ QDate::QDate(int y, int m, int d) /*! \fn bool QDate::isValid() const - Returns true if this date is valid; otherwise returns false. + Returns \c true if this date is valid; otherwise returns \c false. \sa isNull() */ @@ -983,8 +983,8 @@ QString QDate::toString(const QString& format) const /*! \since 4.2 - Sets the date's \a year, \a month, and \a day. Returns true if - the date is valid; otherwise returns false. + Sets the date's \a year, \a month, and \a day. Returns \c true if + the date is valid; otherwise returns \c false. If the specified date is invalid, the QDate object is set to be invalid. @@ -1162,7 +1162,7 @@ qint64 QDate::daysTo(const QDate &d) const /*! \fn bool QDate::operator==(const QDate &d) const - Returns true if this date is equal to \a d; otherwise returns + Returns \c true if this date is equal to \a d; otherwise returns false. */ @@ -1170,36 +1170,36 @@ qint64 QDate::daysTo(const QDate &d) const /*! \fn bool QDate::operator!=(const QDate &d) const - Returns true if this date is different from \a d; otherwise - returns false. + Returns \c true if this date is different from \a d; otherwise + returns \c false. */ /*! \fn bool QDate::operator<(const QDate &d) const - Returns true if this date is earlier than \a d; otherwise returns + Returns \c true if this date is earlier than \a d; otherwise returns false. */ /*! \fn bool QDate::operator<=(const QDate &d) const - Returns true if this date is earlier than or equal to \a d; - otherwise returns false. + Returns \c true if this date is earlier than or equal to \a d; + otherwise returns \c false. */ /*! \fn bool QDate::operator>(const QDate &d) const - Returns true if this date is later than \a d; otherwise returns + Returns \c true if this date is later than \a d; otherwise returns false. */ /*! \fn bool QDate::operator>=(const QDate &d) const - Returns true if this date is later than or equal to \a d; - otherwise returns false. + Returns \c true if this date is later than or equal to \a d; + otherwise returns \c false. */ /*! @@ -1373,8 +1373,8 @@ QDate QDate::fromString(const QString &string, const QString &format) /*! \overload - Returns true if the specified date (\a year, \a month, and \a - day) is valid; otherwise returns false. + Returns \c true if the specified date (\a year, \a month, and \a + day) is valid; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qdatetime.cpp 4 @@ -1395,8 +1395,8 @@ bool QDate::isValid(int year, int month, int day) /*! \fn bool QDate::isLeapYear(int year) - Returns true if the specified \a year is a leap year; otherwise - returns false. + Returns \c true if the specified \a year is a leap year; otherwise + returns \c false. */ bool QDate::isLeapYear(int y) @@ -1475,8 +1475,8 @@ bool QDate::isLeapYear(int y) \fn QTime::QTime() Constructs a null time object. A null time can be a QTime(0, 0, 0, 0) - (i.e., midnight) object, except that isNull() returns true and isValid() - returns false. + (i.e., midnight) object, except that isNull() returns \c true and isValid() + returns \c false. \sa isNull(), isValid() */ @@ -1500,7 +1500,7 @@ QTime::QTime(int h, int m, int s, int ms) /*! \fn bool QTime::isNull() const - Returns true if the time is null (i.e., the QTime object was + Returns \c true if the time is null (i.e., the QTime object was constructed using the default constructor); otherwise returns false. A null time is also an invalid time. @@ -1508,7 +1508,7 @@ QTime::QTime(int h, int m, int s, int ms) */ /*! - Returns true if the time is valid; otherwise returns false. For example, + Returns \c true if the time is valid; otherwise returns \c false. For example, the time 23:30:55.746 is valid, but 24:12:30 is invalid. \sa isNull() @@ -1709,7 +1709,7 @@ QString QTime::toString(const QString& format) const \a h must be in the range 0 to 23, \a m and \a s must be in the range 0 to 59, and \a ms must be in the range 0 to 999. - Returns true if the set time is valid; otherwise returns false. + Returns \c true if the set time is valid; otherwise returns \c false. \sa isValid() */ @@ -1835,39 +1835,39 @@ int QTime::msecsTo(const QTime &t) const /*! \fn bool QTime::operator==(const QTime &t) const - Returns true if this time is equal to \a t; otherwise returns false. + Returns \c true if this time is equal to \a t; otherwise returns \c false. */ /*! \fn bool QTime::operator!=(const QTime &t) const - Returns true if this time is different from \a t; otherwise returns false. + Returns \c true if this time is different from \a t; otherwise returns \c false. */ /*! \fn bool QTime::operator<(const QTime &t) const - Returns true if this time is earlier than \a t; otherwise returns false. + Returns \c true if this time is earlier than \a t; otherwise returns \c false. */ /*! \fn bool QTime::operator<=(const QTime &t) const - Returns true if this time is earlier than or equal to \a t; - otherwise returns false. + Returns \c true if this time is earlier than or equal to \a t; + otherwise returns \c false. */ /*! \fn bool QTime::operator>(const QTime &t) const - Returns true if this time is later than \a t; otherwise returns false. + Returns \c true if this time is later than \a t; otherwise returns \c false. */ /*! \fn bool QTime::operator>=(const QTime &t) const - Returns true if this time is later than or equal to \a t; - otherwise returns false. + Returns \c true if this time is later than or equal to \a t; + otherwise returns \c false. */ /*! @@ -2074,7 +2074,7 @@ QTime QTime::fromString(const QString &string, const QString &format) /*! \overload - Returns true if the specified time is valid; otherwise returns + Returns \c true if the specified time is valid; otherwise returns false. The time is valid if \a h is in the range 0 to 23, \a m and @@ -3060,8 +3060,8 @@ QDateTime &QDateTime::operator=(const QDateTime &other) */ /*! - Returns true if both the date and the time are null; otherwise - returns false. A null datetime is invalid. + Returns \c true if both the date and the time are null; otherwise + returns \c false. A null datetime is invalid. \sa QDate::isNull(), QTime::isNull(), isValid() */ @@ -3072,8 +3072,8 @@ bool QDateTime::isNull() const } /*! - Returns true if both the date and the time are valid and they are valid in - the current Qt::TimeSpec, otherwise returns false. + Returns \c true if both the date and the time are valid and they are valid in + the current Qt::TimeSpec, otherwise returns \c false. If the timeSpec() is Qt::LocalTime or Qt::TimeZone then the date and time are checked to see if they fall in the Standard Time to Daylight Time transition @@ -3958,8 +3958,8 @@ QDateTime QDateTime::toTimeZone(const QTimeZone &timeZone) const #endif // QT_BOOTSTRAPPED /*! - Returns true if this datetime is equal to the \a other datetime; - otherwise returns false. + Returns \c true if this datetime is equal to the \a other datetime; + otherwise returns \c false. \sa operator!=() */ @@ -3978,8 +3978,8 @@ bool QDateTime::operator==(const QDateTime &other) const /*! \fn bool QDateTime::operator!=(const QDateTime &other) const - Returns true if this datetime is different from the \a other - datetime; otherwise returns false. + Returns \c true if this datetime is different from the \a other + datetime; otherwise returns \c false. Two datetimes are different if either the date, the time, or the time zone components are different. @@ -3988,8 +3988,8 @@ bool QDateTime::operator==(const QDateTime &other) const */ /*! - Returns true if this datetime is earlier than the \a other - datetime; otherwise returns false. + Returns \c true if this datetime is earlier than the \a other + datetime; otherwise returns \c false. */ bool QDateTime::operator<(const QDateTime &other) const @@ -4006,22 +4006,22 @@ bool QDateTime::operator<(const QDateTime &other) const /*! \fn bool QDateTime::operator<=(const QDateTime &other) const - Returns true if this datetime is earlier than or equal to the - \a other datetime; otherwise returns false. + Returns \c true if this datetime is earlier than or equal to the + \a other datetime; otherwise returns \c false. */ /*! \fn bool QDateTime::operator>(const QDateTime &other) const - Returns true if this datetime is later than the \a other datetime; - otherwise returns false. + Returns \c true if this datetime is later than the \a other datetime; + otherwise returns \c false. */ /*! \fn bool QDateTime::operator>=(const QDateTime &other) const - Returns true if this datetime is later than or equal to the - \a other datetime; otherwise returns false. + Returns \c true if this datetime is later than or equal to the + \a other datetime; otherwise returns \c false. */ /*! diff --git a/src/corelib/tools/qdatetimeparser.cpp b/src/corelib/tools/qdatetimeparser.cpp index 5da0305a69..fb5c5f5943 100644 --- a/src/corelib/tools/qdatetimeparser.cpp +++ b/src/corelib/tools/qdatetimeparser.cpp @@ -340,8 +340,8 @@ static QString unquote(const QString &str) /*! \internal - Parses the format \a newFormat. If successful, returns true and - sets up the format. Else keeps the old format and returns false. + Parses the format \a newFormat. If successful, returns \c true and + sets up the format. Else keeps the old format and returns \c false. */ @@ -1587,7 +1587,7 @@ QString QDateTimeParser::sectionFormat(Section s, int count) const /*! \internal - Returns true if str can be modified to represent a + Returns \c true if str can be modified to represent a number that is within min and max. */ diff --git a/src/corelib/tools/qeasingcurve.cpp b/src/corelib/tools/qeasingcurve.cpp index fc9a1ca867..5daf067c71 100644 --- a/src/corelib/tools/qeasingcurve.cpp +++ b/src/corelib/tools/qeasingcurve.cpp @@ -1123,7 +1123,7 @@ QEasingCurve::~QEasingCurve() */ /*! - Compare this easing curve with \a other and returns true if they are + Compare this easing curve with \a other and returns \c true if they are equal. It will also compare the properties of a curve. */ bool QEasingCurve::operator==(const QEasingCurve &other) const @@ -1147,7 +1147,7 @@ bool QEasingCurve::operator==(const QEasingCurve &other) const /*! \fn bool QEasingCurve::operator!=(const QEasingCurve &other) const - Compare this easing curve with \a other and returns true if they are not equal. + Compare this easing curve with \a other and returns \c true if they are not equal. It will also compare the properties of a curve. \sa operator==() diff --git a/src/corelib/tools/qelapsedtimer.cpp b/src/corelib/tools/qelapsedtimer.cpp index bdca60757f..1da85fce96 100644 --- a/src/corelib/tools/qelapsedtimer.cpp +++ b/src/corelib/tools/qelapsedtimer.cpp @@ -204,13 +204,13 @@ QT_BEGIN_NAMESPACE /*! \fn bool QElapsedTimer::operator ==(const QElapsedTimer &other) const - Returns true if this object and \a other contain the same time. + Returns \c true if this object and \a other contain the same time. */ /*! \fn bool QElapsedTimer::operator !=(const QElapsedTimer &other) const - Returns true if this object and \a other contain different times. + Returns \c true if this object and \a other contain different times. */ static const qint64 invalidData = Q_INT64_C(0x8000000000000000); @@ -230,7 +230,7 @@ void QElapsedTimer::invalidate() Q_DECL_NOTHROW } /*! - Returns false if this object was invalidated by a call to invalidate() and + Returns \c false if this object was invalidated by a call to invalidate() and has not been restarted since. \sa invalidate(), start(), restart() @@ -241,7 +241,7 @@ bool QElapsedTimer::isValid() const Q_DECL_NOTHROW } /*! - Returns true if this QElapsedTimer has already expired by \a timeout + Returns \c true if this QElapsedTimer has already expired by \a timeout milliseconds (that is, more than \a timeout milliseconds have elapsed). The value of \a timeout can be -1 to indicate that this timer does not expire, in which case this function will always return false. diff --git a/src/corelib/tools/qelapsedtimer_generic.cpp b/src/corelib/tools/qelapsedtimer_generic.cpp index 51e500fe8d..6324be00c0 100644 --- a/src/corelib/tools/qelapsedtimer_generic.cpp +++ b/src/corelib/tools/qelapsedtimer_generic.cpp @@ -55,7 +55,7 @@ QElapsedTimer::ClockType QElapsedTimer::clockType() Q_DECL_NOTHROW } /*! - Returns true if this is a monotonic clock, false otherwise. See the + Returns \c true if this is a monotonic clock, false otherwise. See the information on the different clock types to understand which ones are monotonic. @@ -180,7 +180,7 @@ qint64 QElapsedTimer::secsTo(const QElapsedTimer &other) const Q_DECL_NOTHROW /*! \relates QElapsedTimer - Returns true if \a v1 was started before \a v2, false otherwise. + Returns \c true if \a v1 was started before \a v2, false otherwise. The returned value is undefined if one of the two parameters is invalid and the other isn't. However, two invalid timers are equal and thus this diff --git a/src/corelib/tools/qhash.cpp b/src/corelib/tools/qhash.cpp index b6257c8907..7f6feaf8a0 100644 --- a/src/corelib/tools/qhash.cpp +++ b/src/corelib/tools/qhash.cpp @@ -1007,7 +1007,7 @@ void QHashData::checkSanity() /*! \fn bool QHash::operator==(const QHash &other) const - Returns true if \a other is equal to this hash; otherwise returns + Returns \c true if \a other is equal to this hash; otherwise returns false. Two hashes are considered equal if they contain the same (key, @@ -1020,8 +1020,8 @@ void QHashData::checkSanity() /*! \fn bool QHash::operator!=(const QHash &other) const - Returns true if \a other is not equal to this hash; otherwise - returns false. + Returns \c true if \a other is not equal to this hash; otherwise + returns \c false. Two hashes are considered equal if they contain the same (key, value) pairs. @@ -1040,7 +1040,7 @@ void QHashData::checkSanity() /*! \fn bool QHash::isEmpty() const - Returns true if the hash contains no items; otherwise returns + Returns \c true if the hash contains no items; otherwise returns false. \sa size() @@ -1107,8 +1107,8 @@ void QHashData::checkSanity() \internal - Returns true if the hash's internal data isn't shared with any - other hash object; otherwise returns false. + Returns \c true if the hash's internal data isn't shared with any + other hash object; otherwise returns \c false. \sa detach() */ @@ -1157,8 +1157,8 @@ void QHashData::checkSanity() /*! \fn bool QHash::contains(const Key &key) const - Returns true if the hash contains an item with the \a key; - otherwise returns false. + Returns \c true if the hash contains an item with the \a key; + otherwise returns \c false. \sa count(), QMultiHash::contains() */ @@ -1453,7 +1453,7 @@ void QHashData::checkSanity() This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the hash is empty; otherwise - returns false. + returns \c false. */ /*! \typedef QHash::ConstIterator @@ -1656,8 +1656,8 @@ void QHashData::checkSanity() \fn bool QHash::iterator::operator==(const iterator &other) const \fn bool QHash::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!=() */ @@ -1666,8 +1666,8 @@ void QHashData::checkSanity() \fn bool QHash::iterator::operator!=(const iterator &other) const \fn bool QHash::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==() */ @@ -1847,16 +1847,16 @@ void QHashData::checkSanity() /*! \fn bool QHash::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 QHash::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==() */ @@ -2089,8 +2089,8 @@ void QHashData::checkSanity() \fn bool QMultiHash::contains(const Key &key, const T &value) const \since 4.3 - Returns true if the hash contains an item with the \a key and - \a value; otherwise returns false. + Returns \c true if the hash contains an item with the \a key and + \a value; otherwise returns \c false. \sa QHash::contains() */ diff --git a/src/corelib/tools/qiterator.qdoc b/src/corelib/tools/qiterator.qdoc index 25914967a9..1ae9c58daa 100644 --- a/src/corelib/tools/qiterator.qdoc +++ b/src/corelib/tools/qiterator.qdoc @@ -580,9 +580,9 @@ \fn bool QMutableVectorIterator::hasNext() const \fn bool QMutableSetIterator::hasNext() const - Returns true if there is at least one item ahead of the iterator, + Returns \c true if there is at least one item ahead of the iterator, i.e. the iterator is \e not at the back of the container; - otherwise returns false. + otherwise returns \c false. \sa hasPrevious(), next() */ @@ -649,9 +649,9 @@ \fn bool QMutableVectorIterator::hasPrevious() const \fn bool QMutableSetIterator::hasPrevious() const - Returns true if there is at least one item behind the iterator, + Returns \c true if there is at least one item behind the iterator, i.e. the iterator is \e not at the front of the container; - otherwise returns false. + otherwise returns \c false. \sa hasNext(), previous() */ @@ -720,7 +720,7 @@ \fn bool QMutableSetIterator::findNext(const T &value) Searches for \a value starting from the current iterator position - forward. Returns true if \a value is found; otherwise returns false. + forward. Returns \c true if \a value is found; otherwise returns \c false. After the call, if \a value was found, the iterator is positioned just after the matching item; otherwise, the iterator is @@ -739,7 +739,7 @@ \fn bool QMutableSetIterator::findPrevious(const T &value) Searches for \a value starting from the current iterator position - backward. Returns true if \a value is found; otherwise returns + backward. Returns \c true if \a value is found; otherwise returns false. After the call, if \a value was found, the iterator is positioned @@ -1175,9 +1175,9 @@ \fn bool QMutableMapIterator::hasNext() const \fn bool QMutableHashIterator::hasNext() const - Returns true if there is at least one item ahead of the iterator, + Returns \c true if there is at least one item ahead of the iterator, i.e. the iterator is \e not at the back of the container; - otherwise returns false. + otherwise returns \c false. \sa hasPrevious(), next() */ @@ -1243,9 +1243,9 @@ \fn bool QMutableMapIterator::hasPrevious() const \fn bool QMutableHashIterator::hasPrevious() const - Returns true if there is at least one item behind the iterator, + Returns \c true if there is at least one item behind the iterator, i.e. the iterator is \e not at the front of the container; - otherwise returns false. + otherwise returns \c false. \sa hasNext(), previous() */ @@ -1369,8 +1369,8 @@ \fn bool QMutableHashIterator::findNext(const T &value) Searches for \a value starting from the current iterator position - forward. Returns true if a (key, value) pair with value \a value - is found; otherwise returns false. + forward. Returns \c true if a (key, value) pair with value \a value + is found; otherwise returns \c false. After the call, if \a value was found, the iterator is positioned just after the matching item; otherwise, the iterator is @@ -1385,8 +1385,8 @@ \fn bool QMutableHashIterator::findPrevious(const T &value) Searches for \a value starting from the current iterator position - backward. Returns true if a (key, value) pair with value \a value - is found; otherwise returns false. + backward. Returns \c true if a (key, value) pair with value \a value + is found; otherwise returns \c false. After the call, if \a value was found, the iterator is positioned just before the matching item; otherwise, the iterator is diff --git a/src/corelib/tools/qline.cpp b/src/corelib/tools/qline.cpp index 3fb958fae6..990e6bef09 100644 --- a/src/corelib/tools/qline.cpp +++ b/src/corelib/tools/qline.cpp @@ -101,8 +101,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QLine::isNull() const - Returns true if the line is not set up with valid start and end point; - otherwise returns false. + Returns \c true if the line is not set up with valid start and end point; + otherwise returns \c false. */ /*! @@ -172,7 +172,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QLine::operator!=(const QLine &line) const - Returns true if the given \a line is not the same as \e this line. + Returns \c true if the given \a line is not the same as \e this line. A line is different from another line if any of their start or end points differ, or the internal order of the points is different. @@ -181,7 +181,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QLine::operator==(const QLine &line) const - Returns true if the given \a line is the same as \e this line. + Returns \c true if the given \a line is the same as \e this line. A line is identical to another line if the start and end points are identical, and the internal order of the points is the same. @@ -416,8 +416,8 @@ QDataStream &operator>>(QDataStream &stream, QLine &line) /*! \fn bool QLineF::isNull() const - Returns true if the line is not set up with valid start and end point; - otherwise returns false. + Returns \c true if the line is not set up with valid start and end point; + otherwise returns \c false. */ /*! @@ -520,7 +520,7 @@ QDataStream &operator>>(QDataStream &stream, QLine &line) /*! \fn bool QLineF::operator!=(const QLineF &line) const - Returns true if the given \a line is not the same as \e this line. + Returns \c true if the given \a line is not the same as \e this line. A line is different from another line if their start or end points differ, or the internal order of the points is different. @@ -529,7 +529,7 @@ QDataStream &operator>>(QDataStream &stream, QLine &line) /*! \fn bool QLineF::operator==(const QLineF &line) const - Returns true if the given \a line is the same as this line. + Returns \c true if the given \a line is the same as this line. A line is identical to another line if the start and end points are identical, and the internal order of the points is the same. diff --git a/src/corelib/tools/qlinkedlist.cpp b/src/corelib/tools/qlinkedlist.cpp index c6e79c02a3..28319f3fda 100644 --- a/src/corelib/tools/qlinkedlist.cpp +++ b/src/corelib/tools/qlinkedlist.cpp @@ -176,7 +176,7 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::operator==(const QLinkedList &other) const - Returns true if \a other is equal to this list; otherwise returns + Returns \c true if \a other is equal to this list; otherwise returns false. Two lists are considered equal if they contain the same values in @@ -190,8 +190,8 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::operator!=(const QLinkedList &other) const - Returns true if \a other is not equal to this list; otherwise - returns false. + Returns \c true if \a other is not equal to this list; otherwise + returns \c false. Two lists are considered equal if they contain the same values in the same order. @@ -231,7 +231,7 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::isEmpty() const - Returns true if the list contains no items; otherwise returns + Returns \c true if the list contains no items; otherwise returns false. \sa size() @@ -285,8 +285,8 @@ const QLinkedListData QLinkedListData::shared_null = { \fn bool QLinkedList::removeOne(const T &value) \since 4.4 - Removes the first occurrences of \a value in the list. Returns true on - success; otherwise returns false. + Removes the first occurrences of \a value in the list. Returns \c true on + success; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qlinkedlist.cpp 6 @@ -299,8 +299,8 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::contains(const T &value) const - Returns true if the list contains an occurrence of \a value; - otherwise returns false. + Returns \c true if the list contains an occurrence of \a value; + otherwise returns \c false. This function requires the value type to have an implementation of \c operator==(). @@ -321,8 +321,8 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::startsWith(const T &value) const \since 4.5 - Returns true if the list is not empty and its first - item is equal to \a value; otherwise returns false. + Returns \c true if the list is not empty and its first + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), first() */ @@ -330,8 +330,8 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::endsWith(const T &value) const \since 4.5 - Returns true if the list is not empty and its last - item is equal to \a value; otherwise returns false. + Returns \c true if the list is not empty and its last + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), last() */ @@ -589,7 +589,7 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::empty() const This function is provided for STL compatibility. It is equivalent - to isEmpty() and returns true if the list is empty. + to isEmpty() and returns \c true if the list is empty. */ /*! \fn QLinkedList &QLinkedList::operator+=(const QLinkedList &other) @@ -780,8 +780,8 @@ const QLinkedListData QLinkedListData::shared_null = { \fn bool QLinkedList::iterator::operator==(const iterator &other) const \fn bool QLinkedList::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!=() */ @@ -790,8 +790,8 @@ const QLinkedListData QLinkedListData::shared_null = { \fn bool QLinkedList::iterator::operator!=(const iterator &other) const \fn bool QLinkedList::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==() */ @@ -986,16 +986,16 @@ const QLinkedListData QLinkedListData::shared_null = { /*! \fn bool QLinkedList::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 QLinkedList::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==() */ diff --git a/src/corelib/tools/qlist.cpp b/src/corelib/tools/qlist.cpp index 4770054d79..5bced19404 100644 --- a/src/corelib/tools/qlist.cpp +++ b/src/corelib/tools/qlist.cpp @@ -553,7 +553,7 @@ void **QListData::erase(void **xi) /*! \fn bool QList::operator==(const QList &other) const - Returns true if \a other is equal to this list; otherwise returns + Returns \c true if \a other is equal to this list; otherwise returns false. Two lists are considered equal if they contain the same values in @@ -567,8 +567,8 @@ void **QListData::erase(void **xi) /*! \fn bool QList::operator!=(const QList &other) const - Returns true if \a other is not equal to this list; otherwise - returns false. + Returns \c true if \a other is not equal to this list; otherwise + returns \c false. Two lists are considered equal if they contain the same values in the same order. @@ -618,7 +618,7 @@ void **QListData::erase(void **xi) /*! \fn bool QList::isEmpty() const - Returns true if the list contains no items; otherwise returns + Returns \c true if the list contains no items; otherwise returns false. \sa size() @@ -767,7 +767,7 @@ void **QListData::erase(void **xi) \since 4.4 Removes the first occurrence of \a value in the list and returns - true on success; otherwise returns false. + true on success; otherwise returns \c false. Example: \snippet code/src_corelib_tools_qlistdata.cpp 10 @@ -894,8 +894,8 @@ void **QListData::erase(void **xi) /*! \fn bool QList::contains(const T &value) const - Returns true if the list contains an occurrence of \a value; - otherwise returns false. + Returns \c true if the list contains an occurrence of \a value; + otherwise returns \c false. This function requires the value type to have an implementation of \c operator==(). @@ -916,8 +916,8 @@ void **QListData::erase(void **xi) /*! \fn bool QList::startsWith(const T &value) const \since 4.5 - Returns true if this list is not empty and its first - item is equal to \a value; otherwise returns false. + Returns \c true if this list is not empty and its first + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), contains() */ @@ -925,8 +925,8 @@ void **QListData::erase(void **xi) /*! \fn bool QList::endsWith(const T &value) const \since 4.5 - Returns true if this list is not empty and its last - item is equal to \a value; otherwise returns false. + Returns \c true if this list is not empty and its last + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), contains() */ @@ -1196,7 +1196,7 @@ void **QListData::erase(void **xi) /*! \fn bool QList::empty() const This function is provided for STL compatibility. It is equivalent - to isEmpty() and returns true if the list is empty. + to isEmpty() and returns \c true if the list is empty. */ /*! \fn QList &QList::operator+=(const QList &other) @@ -1372,8 +1372,8 @@ void **QListData::erase(void **xi) \fn bool QList::iterator::operator==(const iterator &other) const \fn bool QList::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!=() */ @@ -1382,8 +1382,8 @@ void **QListData::erase(void **xi) \fn bool QList::iterator::operator!=(const iterator &other) const \fn bool QList::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==() */ @@ -1392,7 +1392,7 @@ void **QListData::erase(void **xi) \fn bool QList::iterator::operator<(const iterator& other) const \fn bool QList::iterator::operator<(const const_iterator& other) const - Returns true if the item pointed to by this iterator is less than + Returns \c true if the item pointed to by this iterator is less than the item pointed to by the \a other iterator. */ @@ -1400,7 +1400,7 @@ void **QListData::erase(void **xi) \fn bool QList::iterator::operator<=(const iterator& other) const \fn bool QList::iterator::operator<=(const const_iterator& other) const - Returns true if the item pointed to by this iterator is less than + Returns \c true if the item pointed to by this iterator is less than or equal to the item pointed to by the \a other iterator. */ @@ -1408,7 +1408,7 @@ void **QListData::erase(void **xi) \fn bool QList::iterator::operator>(const iterator& other) const \fn bool QList::iterator::operator>(const const_iterator& other) const - Returns true if the item pointed to by this iterator is greater + Returns \c true if the item pointed to by this iterator is greater than the item pointed to by the \a other iterator. */ @@ -1416,7 +1416,7 @@ void **QListData::erase(void **xi) \fn bool QList::iterator::operator>=(const iterator& other) const \fn bool QList::iterator::operator>=(const const_iterator& other) const - Returns true if the item pointed to by this iterator is greater + Returns \c true if the item pointed to by this iterator is greater than or equal to the item pointed to by the \a other iterator. */ @@ -1619,16 +1619,16 @@ void **QListData::erase(void **xi) /*! \fn bool QList::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 QList::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==() */ @@ -1636,28 +1636,28 @@ void **QListData::erase(void **xi) /*! \fn bool QList::const_iterator::operator<(const const_iterator& other) const - Returns true if the item pointed to by this iterator is less than + Returns \c true if the item pointed to by this iterator is less than the item pointed to by the \a other iterator. */ /*! \fn bool QList::const_iterator::operator<=(const const_iterator& other) const - Returns true if the item pointed to by this iterator is less than + Returns \c true if the item pointed to by this iterator is less than or equal to the item pointed to by the \a other iterator. */ /*! \fn bool QList::const_iterator::operator>(const const_iterator& other) const - Returns true if the item pointed to by this iterator is greater + Returns \c true if the item pointed to by this iterator is greater than the item pointed to by the \a other iterator. */ /*! \fn bool QList::const_iterator::operator>=(const const_iterator& other) const - Returns true if the item pointed to by this iterator is greater + Returns \c true if the item pointed to by this iterator is greater than or equal to the item pointed to by the \a other iterator. */ diff --git a/src/corelib/tools/qlocale.qdoc b/src/corelib/tools/qlocale.qdoc index a3b38c41f4..aceb130857 100644 --- a/src/corelib/tools/qlocale.qdoc +++ b/src/corelib/tools/qlocale.qdoc @@ -907,15 +907,15 @@ /*! \fn bool QLocale::operator==(const QLocale &other) const - Returns true if the QLocale object is the same as the \a other - locale specified; otherwise returns false. + Returns \c true if the QLocale object is the same as the \a other + locale specified; otherwise returns \c false. */ /*! \fn bool QLocale::operator!=(const QLocale &other) const - Returns true if the QLocale object is not the same as the \a other - locale specified; otherwise returns false. + Returns \c true if the QLocale object is not the same as the \a other + locale specified; otherwise returns \c false. */ /*! 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 &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 &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() */ diff --git a/src/corelib/tools/qmargins.cpp b/src/corelib/tools/qmargins.cpp index 2cdc3f3f03..c5bd8468bc 100644 --- a/src/corelib/tools/qmargins.cpp +++ b/src/corelib/tools/qmargins.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE QMargin defines a set of four margins; left, top, right and bottom, that describe the size of the borders surrounding a rectangle. - The isNull() function returns true only if all margins are set to zero. + The isNull() function returns \c true only if all margins are set to zero. QMargin objects can be streamed as well as compared. */ @@ -85,7 +85,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QMargins::isNull() const - Returns true if all margins are is 0; otherwise returns + Returns \c true if all margins are is 0; otherwise returns false. */ @@ -147,14 +147,14 @@ QT_BEGIN_NAMESPACE \fn bool operator==(const QMargins &m1, const QMargins &m2) \relates QMargins - Returns true if \a m1 and \a m2 are equal; otherwise returns false. + Returns \c true if \a m1 and \a m2 are equal; otherwise returns \c false. */ /*! \fn bool operator!=(const QMargins &m1, const QMargins &m2) \relates QMargins - Returns true if \a m1 and \a m2 are different; otherwise returns false. + Returns \c true if \a m1 and \a m2 are different; otherwise returns \c false. */ /*! diff --git a/src/corelib/tools/qmessageauthenticationcode.cpp b/src/corelib/tools/qmessageauthenticationcode.cpp index becaaaa704..2eeebed6cd 100644 --- a/src/corelib/tools/qmessageauthenticationcode.cpp +++ b/src/corelib/tools/qmessageauthenticationcode.cpp @@ -227,7 +227,7 @@ void QMessageAuthenticationCode::addData(const QByteArray &data) /*! Reads the data from the open QIODevice \a device until it ends - and adds it to message. Returns true if reading was successful. + and adds it to message. Returns \c true if reading was successful. \note \a device must be already opened. */ diff --git a/src/corelib/tools/qpair.qdoc b/src/corelib/tools/qpair.qdoc index dd3df8c464..be329a0df0 100644 --- a/src/corelib/tools/qpair.qdoc +++ b/src/corelib/tools/qpair.qdoc @@ -120,7 +120,7 @@ \relates QPair - Returns true if \a p1 is equal to \a p2; otherwise returns false. + Returns \c true if \a p1 is equal to \a p2; otherwise returns \c false. Two pairs compare equal if their \c first data members compare equal and if their \c second data members compare equal. @@ -132,7 +132,7 @@ \relates QPair - Returns true if \a p1 is not equal to \a p2; otherwise returns + Returns \c true if \a p1 is not equal to \a p2; otherwise returns false. Two pairs compare as not equal if their \c first data members are not equal or if their \c second data members are not equal. @@ -145,7 +145,7 @@ \relates QPair - Returns true if \a p1 is less than \a p2; otherwise returns + Returns \c true if \a p1 is less than \a p2; otherwise returns false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. @@ -158,7 +158,7 @@ \relates QPair - Returns true if \a p1 is greater than \a p2; otherwise returns + Returns \c true if \a p1 is greater than \a p2; otherwise returns false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. @@ -171,8 +171,8 @@ \relates QPair - Returns true if \a p1 is less than or equal to \a p2; otherwise - returns false. The comparison is done on the \c first members of + Returns \c true if \a p1 is less than or equal to \a p2; otherwise + returns \c false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. @@ -184,8 +184,8 @@ \relates QPair - Returns true if \a p1 is greater than or equal to \a p2; - otherwise returns false. The comparison is done on the \c first + Returns \c true if \a p1 is greater than or equal to \a p2; + otherwise returns \c false. The comparison is done on the \c first members of \a p1 and \a p2; if they compare equal, the \c second members are compared to break the tie. diff --git a/src/corelib/tools/qpoint.cpp b/src/corelib/tools/qpoint.cpp index 784d96bf1c..565b1223fe 100644 --- a/src/corelib/tools/qpoint.cpp +++ b/src/corelib/tools/qpoint.cpp @@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE A point is specified by a x coordinate and an y coordinate which can be accessed using the x() and y() functions. The isNull() - function returns true if both x and y are set to 0. The + function returns \c true if both x and y are set to 0. The coordinates can be set (or altered) using the setX() and setY() functions, or alternatively the rx() and ry() functions which return references to the coordinates (allowing direct @@ -102,8 +102,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QPoint::isNull() const - Returns true if both the x and y coordinates are set to 0, - otherwise returns false. + Returns \c true if both the x and y coordinates are set to 0, + otherwise returns \c false. */ /*! @@ -235,7 +235,7 @@ QT_BEGIN_NAMESPACE \fn bool operator==(const QPoint &p1, const QPoint &p2) \relates QPoint - Returns true if \a p1 and \a p2 are equal; otherwise returns + Returns \c true if \a p1 and \a p2 are equal; otherwise returns false. */ @@ -243,7 +243,7 @@ QT_BEGIN_NAMESPACE \fn bool operator!=(const QPoint &p1, const QPoint &p2) \relates QPoint - Returns true if \a p1 and \a p2 are not equal; otherwise returns false. + Returns \c true if \a p1 and \a p2 are not equal; otherwise returns \c false. */ /*! @@ -474,7 +474,7 @@ QDebug operator<<(QDebug d, const QPointF &p) A point is specified by a x coordinate and an y coordinate which can be accessed using the x() and y() functions. The coordinates of the point are specified using floating point numbers for - accuracy. The isNull() function returns true if both x and y are + accuracy. The isNull() function returns \c true if both x and y are set to 0.0. The coordinates can be set (or altered) using the setX() and setY() functions, or alternatively the rx() and ry() functions which return references to the coordinates (allowing direct @@ -524,8 +524,8 @@ QDebug operator<<(QDebug d, const QPointF &p) /*! \fn bool QPointF::isNull() const - Returns true if both the x and y coordinates are set to +0.0; - otherwise returns false. + Returns \c true if both the x and y coordinates are set to +0.0; + otherwise returns \c false. \note Since this function treats +0.0 and -0.0 differently, points with zero-valued coordinates where either or both values have a @@ -733,14 +733,14 @@ QDebug operator<<(QDebug d, const QPointF &p) \fn bool operator==(const QPointF &p1, const QPointF &p2) \relates QPointF - Returns true if \a p1 is equal to \a p2; otherwise returns false. + Returns \c true if \a p1 is equal to \a p2; otherwise returns \c false. */ /*! \fn bool operator!=(const QPointF &p1, const QPointF &p2); \relates QPointF - Returns true if \a p1 is not equal to \a p2; otherwise returns false. + Returns \c true if \a p1 is not equal to \a p2; otherwise returns \c false. */ #ifndef QT_NO_DATASTREAM diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp index 41b2b266ee..fcff8931e8 100644 --- a/src/corelib/tools/qrect.cpp +++ b/src/corelib/tools/qrect.cpp @@ -92,7 +92,7 @@ QT_BEGIN_NAMESPACE setRight(). The contains() function tells whether a given point is inside the - rectangle or not, and the intersects() function returns true if + rectangle or not, and the intersects() function returns \c true if this rectangle intersects with a given rectangle. The QRect class also provides the intersected() function which returns the intersection rectangle, and the united() function which returns the @@ -107,9 +107,9 @@ QT_BEGIN_NAMESPACE \li united() \endtable - The isEmpty() function returns true if left() > right() or top() > + The isEmpty() function returns \c true if left() > right() or top() > bottom(). Note that an empty rectangle is not valid: The isValid() - function returns true if left() <= right() \e and top() <= + function returns \c true if left() <= right() \e and top() <= bottom(). A null rectangle (isNull() == true) on the other hand, has both width and height set to 0. @@ -254,8 +254,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QRect::isNull() const - Returns true if the rectangle is a null rectangle, otherwise - returns false. + Returns \c true if the rectangle is a null rectangle, otherwise + returns \c false. A null rectangle has both the width and the height set to 0 (i.e., right() == left() - 1 and bottom() == top() - 1). A null rectangle @@ -267,7 +267,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QRect::isEmpty() const - Returns true if the rectangle is empty, otherwise returns false. + Returns \c true if the rectangle is empty, otherwise returns \c false. An empty rectangle has a left() > right() or top() > bottom(). An empty rectangle is not valid (i.e., isEmpty() == !isValid()). @@ -281,7 +281,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QRect::isValid() const - Returns true if the rectangle is valid, otherwise returns false. + Returns \c true if the rectangle is valid, otherwise returns \c false. A valid rectangle has a left() < right() and top() < bottom(). Note that non-trivial operations like intersections are @@ -803,9 +803,9 @@ QRect QRect::normalized() const /*! \fn bool QRect::contains(const QPoint &point, bool proper) const - Returns true if the given \a point is inside or on the edge of - the rectangle, otherwise returns false. If \a proper is true, this - function only returns true if the given \a point is \e inside the + Returns \c true if the given \a point is inside or on the edge of + the rectangle, otherwise returns \c false. If \a proper is true, this + function only returns \c true if the given \a point is \e inside the rectangle (i.e., not on the edge). \sa intersects() @@ -851,9 +851,9 @@ bool QRect::contains(const QPoint &p, bool proper) const \fn bool QRect::contains(int x, int y, bool proper) const \overload - Returns true if the point (\a x, \a y) is inside or on the edge of - the rectangle, otherwise returns false. If \a proper is true, this - function only returns true if the point is entirely inside the + Returns \c true if the point (\a x, \a y) is inside or on the edge of + the rectangle, otherwise returns \c false. If \a proper is true, this + function only returns \c true if the point is entirely inside the rectangle(not on the edge). */ @@ -861,17 +861,17 @@ bool QRect::contains(const QPoint &p, bool proper) const \fn bool QRect::contains(int x, int y) const \overload - Returns true if the point (\a x, \a y) is inside this rectangle, - otherwise returns false. + Returns \c true if the point (\a x, \a y) is inside this rectangle, + otherwise returns \c false. */ /*! \fn bool QRect::contains(const QRect &rectangle, bool proper) const \overload - Returns true if the given \a rectangle is inside this rectangle. - otherwise returns false. If \a proper is true, this function only - returns true if the \a rectangle is entirely inside this + Returns \c true if the given \a rectangle is inside this rectangle. + otherwise returns \c false. If \a proper is true, this function only + returns \c true if the \a rectangle is entirely inside this rectangle (not on the edge). */ @@ -1093,9 +1093,9 @@ QRect QRect::operator&(const QRect &r) const /*! \fn bool QRect::intersects(const QRect &rectangle) const - Returns true if this rectangle intersects with the given \a + Returns \c true if this rectangle intersects with the given \a rectangle (i.e., there is at least one pixel that is within both - rectangles), otherwise returns false. + rectangles), otherwise returns \c false. The intersection rectangle can be retrieved using the intersected() function. @@ -1149,8 +1149,8 @@ bool QRect::intersects(const QRect &r) const \fn bool operator==(const QRect &r1, const QRect &r2) \relates QRect - Returns true if the rectangles \a r1 and \a r2 are equal, - otherwise returns false. + Returns \c true if the rectangles \a r1 and \a r2 are equal, + otherwise returns \c false. */ @@ -1158,8 +1158,8 @@ bool QRect::intersects(const QRect &r) const \fn bool operator!=(const QRect &r1, const QRect &r2) \relates QRect - Returns true if the rectangles \a r1 and \a r2 are different, otherwise - returns false. + Returns \c true if the rectangles \a r1 and \a r2 are different, otherwise + returns \c false. */ @@ -1267,7 +1267,7 @@ QDebug operator<<(QDebug dbg, const QRect &r) { setRight(). The contains() function tells whether a given point is inside the - rectangle or not, and the intersects() function returns true if + rectangle or not, and the intersects() function returns \c true if this rectangle intersects with a given rectangle (otherwise false). The QRectF class also provides the intersected() function which returns the intersection rectangle, and the united() function @@ -1283,9 +1283,9 @@ QDebug operator<<(QDebug dbg, const QRect &r) { \li united() \endtable - The isEmpty() function returns true if the rectangle's width or + The isEmpty() function returns \c true if the rectangle's width or height is less than, or equal to, 0. Note that an empty rectangle - is not valid: The isValid() function returns true if both width + is not valid: The isValid() function returns \c true if both width and height is larger than 0. A null rectangle (isNull() == true) on the other hand, has both width and height set to 0. @@ -1412,7 +1412,7 @@ QDebug operator<<(QDebug dbg, const QRect &r) { /*! \fn bool QRectF::isNull() const - Returns true if the rectangle is a null rectangle, otherwise returns false. + Returns \c true if the rectangle is a null rectangle, otherwise returns \c false. A null rectangle has both the width and the height set to 0. A null rectangle is also empty, and hence not valid. @@ -1423,7 +1423,7 @@ QDebug operator<<(QDebug dbg, const QRect &r) { /*! \fn bool QRectF::isEmpty() const - Returns true if the rectangle is empty, otherwise returns false. + Returns \c true if the rectangle is empty, otherwise returns \c false. An empty rectangle has width() <= 0 or height() <= 0. An empty rectangle is not valid (i.e., isEmpty() == !isValid()). @@ -1437,7 +1437,7 @@ QDebug operator<<(QDebug dbg, const QRect &r) { /*! \fn bool QRectF::isValid() const - Returns true if the rectangle is valid, otherwise returns false. + Returns \c true if the rectangle is valid, otherwise returns \c false. A valid rectangle has a width() > 0 and height() > 0. Note that non-trivial operations like intersections are not defined for @@ -1865,8 +1865,8 @@ QRectF QRectF::normalized() const /*! \fn bool QRectF::contains(const QPointF &point) const - Returns true if the given \a point is inside or on the edge of the - rectangle; otherwise returns false. + Returns \c true if the given \a point is inside or on the edge of the + rectangle; otherwise returns \c false. \sa intersects() */ @@ -1905,16 +1905,16 @@ bool QRectF::contains(const QPointF &p) const \fn bool QRectF::contains(qreal x, qreal y) const \overload - Returns true if the point (\a x, \a y) is inside or on the edge of - the rectangle; otherwise returns false. + Returns \c true if the point (\a x, \a y) is inside or on the edge of + the rectangle; otherwise returns \c false. */ /*! \fn bool QRectF::contains(const QRectF &rectangle) const \overload - Returns true if the given \a rectangle is inside this rectangle; - otherwise returns false. + Returns \c true if the given \a rectangle is inside this rectangle; + otherwise returns \c false. */ bool QRectF::contains(const QRectF &r) const @@ -2199,9 +2199,9 @@ QRectF QRectF::operator&(const QRectF &r) const /*! \fn bool QRectF::intersects(const QRectF &rectangle) const - Returns true if this rectangle intersects with the given \a + Returns \c true if this rectangle intersects with the given \a rectangle (i.e. there is a non-empty area of overlap between - them), otherwise returns false. + them), otherwise returns \c false. The intersection rectangle can be retrieved using the intersected() function. @@ -2298,8 +2298,8 @@ QRect QRectF::toAlignedRect() const \fn bool operator==(const QRectF &r1, const QRectF &r2) \relates QRectF - Returns true if the rectangles \a r1 and \a r2 are equal, - otherwise returns false. + Returns \c true if the rectangles \a r1 and \a r2 are equal, + otherwise returns \c false. */ @@ -2307,8 +2307,8 @@ QRect QRectF::toAlignedRect() const \fn bool operator!=(const QRectF &r1, const QRectF &r2) \relates QRectF - Returns true if the rectangles \a r1 and \a r2 are different, otherwise - returns false. + Returns \c true if the rectangles \a r1 and \a r2 are different, otherwise + returns \c false. */ /***************************************************************************** diff --git a/src/corelib/tools/qregexp.cpp b/src/corelib/tools/qregexp.cpp index 5debb1a238..88499ad9d9 100644 --- a/src/corelib/tools/qregexp.cpp +++ b/src/corelib/tools/qregexp.cpp @@ -1794,7 +1794,7 @@ static bool isBetterCapture(int ncap, const int *begin1, const int *end1, const #endif /* - Returns true if anchor a matches at position pos + i in the input + Returns \c true if anchor a matches at position pos + i in the input string, otherwise false. */ bool QRegExpMatchState::testAnchor(int i, int a, const int *capBegin) @@ -4029,8 +4029,8 @@ QRegExp &QRegExp::operator=(const QRegExp &rx) */ /*! - Returns true if this regular expression is equal to \a rx; - otherwise returns false. + Returns \c true if this regular expression is equal to \a rx; + otherwise returns \c false. Two QRegExp objects are equal if they have the same pattern strings and the same settings for case sensitivity, wildcard and @@ -4044,18 +4044,18 @@ bool QRegExp::operator==(const QRegExp &rx) const /*! \fn bool QRegExp::operator!=(const QRegExp &rx) const - Returns true if this regular expression is not equal to \a rx; - otherwise returns false. + Returns \c true if this regular expression is not equal to \a rx; + otherwise returns \c false. \sa operator==() */ /*! - Returns true if the pattern string is empty; otherwise returns + Returns \c true if the pattern string is empty; otherwise returns false. If you call exactMatch() with an empty pattern on an empty string - it will return true; otherwise it returns false since it operates + it will return true; otherwise it returns \c false since it operates over the whole string. If you call indexIn() with an empty pattern on \e any string it will return the start offset (0 by default) because the empty pattern matches the 'emptiness' at the start of @@ -4071,7 +4071,7 @@ bool QRegExp::isEmpty() const } /*! - Returns true if the regular expression is valid; otherwise returns + Returns \c true if the regular expression is valid; otherwise returns false. An invalid regular expression never matches. The pattern \b{[a-z} is an example of an invalid pattern, since @@ -4181,8 +4181,8 @@ void QRegExp::setPatternSyntax(PatternSyntax syntax) } /*! - Returns true if minimal (non-greedy) matching is enabled; - otherwise returns false. + Returns \c true if minimal (non-greedy) matching is enabled; + otherwise returns \c false. \sa caseSensitivity(), setMinimal() */ @@ -4215,8 +4215,8 @@ void QRegExp::setMinimal(bool minimal) // ### Qt 5: make non-const /*! - Returns true if \a str is matched exactly by this regular - expression; otherwise returns false. You can determine how much of + Returns \c true if \a str is matched exactly by this regular + expression; otherwise returns \c false. You can determine how much of the string was matched by calling matchedLength(). For a given regexp string R, exactMatch("R") is the equivalent of @@ -4225,8 +4225,8 @@ void QRegExp::setMinimal(bool minimal) sets matchedLength() differently. For example, if the regular expression is \b{blue}, then - exactMatch() returns true only for input \c blue. For inputs \c - bluebell, \c blutak and \c lightblue, exactMatch() returns false + exactMatch() returns \c true only for input \c blue. For inputs \c + bluebell, \c blutak and \c lightblue, exactMatch() returns \c false and matchedLength() will return 4, 3 and 0 respectively. Although const, this function sets matchedLength(), diff --git a/src/corelib/tools/qregularexpression.cpp b/src/corelib/tools/qregularexpression.cpp index a2a58f8926..d5bd1dff00 100644 --- a/src/corelib/tools/qregularexpression.cpp +++ b/src/corelib/tools/qregularexpression.cpp @@ -1580,7 +1580,7 @@ QStringList QRegularExpression::namedCaptureGroups() const } /*! - Returns true if the regular expression is a valid regular expression (that + Returns \c true if the regular expression is a valid regular expression (that is, it contains no syntax errors, etc.), or false otherwise. Use errorString() to obtain a textual description of the error. @@ -1666,7 +1666,7 @@ QRegularExpressionMatchIterator QRegularExpression::globalMatch(const QString &s } /*! - Returns true if the regular expression is equal to \a re, or false + Returns \c true if the regular expression is equal to \a re, or false otherwise. Two QRegularExpression objects are equal if they have the same pattern string and the same pattern options. @@ -1681,7 +1681,7 @@ bool QRegularExpression::operator==(const QRegularExpression &re) const /*! \fn bool QRegularExpression::operator!=(const QRegularExpression &re) const - Returns true if the regular expression is different from \a re, or + Returns \c true if the regular expression is different from \a re, or false otherwise. \sa operator==() @@ -2058,7 +2058,7 @@ int QRegularExpressionMatch::capturedEnd(const QString &name) const } /*! - Returns true if the regular expression matched against the subject string, + Returns \c true if the regular expression matched against the subject string, or false otherwise. \sa QRegularExpression::match(), hasPartialMatch() @@ -2069,7 +2069,7 @@ bool QRegularExpressionMatch::hasMatch() const } /*! - Returns true if the regular expression partially matched against the + Returns \c true if the regular expression partially matched against the subject string, or false otherwise. \note Only a match that explicitly used the one of the partial match types @@ -2084,9 +2084,9 @@ bool QRegularExpressionMatch::hasPartialMatch() const } /*! - Returns true if the match object was obtained as a result from the + Returns \c true if the match object was obtained as a result from the QRegularExpression::match() function invoked on a valid QRegularExpression - object; returns false if the QRegularExpression was invalid. + object; returns \c false if the QRegularExpression was invalid. \sa QRegularExpression::match(), QRegularExpression::isValid() */ @@ -2159,9 +2159,9 @@ QRegularExpressionMatchIterator &QRegularExpressionMatchIterator::operator=(cons */ /*! - Returns true if the iterator object was obtained as a result from the + Returns \c true if the iterator object was obtained as a result from the QRegularExpression::globalMatch() function invoked on a valid - QRegularExpression object; returns false if the QRegularExpression was + QRegularExpression object; returns \c false if the QRegularExpression was invalid. \sa QRegularExpression::globalMatch(), QRegularExpression::isValid() @@ -2172,8 +2172,8 @@ bool QRegularExpressionMatchIterator::isValid() const } /*! - Returns true if there is at least one match result ahead of the iterator; - otherwise it returns false. + Returns \c true if there is at least one match result ahead of the iterator; + otherwise it returns \c false. \sa next() */ diff --git a/src/corelib/tools/qscopedpointer.cpp b/src/corelib/tools/qscopedpointer.cpp index e0c369ecad..f567eded49 100644 --- a/src/corelib/tools/qscopedpointer.cpp +++ b/src/corelib/tools/qscopedpointer.cpp @@ -180,18 +180,18 @@ QT_BEGIN_NAMESPACE /*! \fn bool operator==(const QScopedPointer &lhs, const QScopedPointer &rhs) - Equality operator. Returns true if the scoped pointers + Equality operator. Returns \c true if the scoped pointers \a lhs and \a rhs are pointing to the same object. - Otherwise returns false. + Otherwise returns \c false. */ /*! \fn bool operator!=(const QScopedPointer &lhs, const QScopedPointer &rhs) - Inequality operator. Returns true if the scoped pointers + Inequality operator. Returns \c true if the scoped pointers \a lhs and \a rhs are \e not pointing to the same object. - Otherwise returns false. + Otherwise returns \c false. */ /*! diff --git a/src/corelib/tools/qset.qdoc b/src/corelib/tools/qset.qdoc index c1351943e1..a0bc206014 100644 --- a/src/corelib/tools/qset.qdoc +++ b/src/corelib/tools/qset.qdoc @@ -143,8 +143,8 @@ /*! \fn bool QSet::operator==(const QSet &other) const - Returns true if the \a other set is equal to this set; otherwise - returns false. + Returns \c true if the \a other set is equal to this set; otherwise + returns \c false. Two sets are considered equal if they contain the same elements. @@ -156,8 +156,8 @@ /*! \fn bool QSet::operator!=(const QSet &other) const - Returns true if the \a other set is not equal to this set; otherwise - returns false. + Returns \c true if the \a other set is not equal to this set; otherwise + returns \c false. Two sets are considered equal if they contain the same elements. @@ -177,7 +177,7 @@ /*! \fn bool QSet::isEmpty() const - Returns true if the set contains no elements; otherwise returns + Returns \c true if the set contains no elements; otherwise returns false. \sa size() @@ -248,8 +248,8 @@ \internal - Returns true if the set's internal data isn't shared with any - other set object; otherwise returns false. + Returns \c true if the set's internal data isn't shared with any + other set object; otherwise returns \c false. \sa detach() */ @@ -271,7 +271,7 @@ \fn bool QSet::remove(const T &value) Removes any occurrence of item \a value from the set. Returns - true if an item was actually removed; otherwise returns false. + true if an item was actually removed; otherwise returns \c false. \sa contains(), insert() */ @@ -322,7 +322,7 @@ /*! \fn bool QSet::contains(const T &value) const - Returns true if the set contains item \a value; otherwise returns + Returns \c true if the set contains item \a value; otherwise returns false. \sa insert(), remove(), find() @@ -332,8 +332,8 @@ \fn bool QSet::contains(const QSet &other) const \since 4.6 - Returns true if the set contains all items from the \a other set; - otherwise returns false. + Returns \c true if the set contains all items from the \a other set; + otherwise returns \c false. \sa insert(), remove(), find() */ @@ -505,7 +505,7 @@ /*! \fn bool QSet::empty() const - Returns true if the set is empty. This function is provided + Returns \c true if the set is empty. This function is provided for STL compatibility. It is equivalent to isEmpty(). */ @@ -788,8 +788,8 @@ \fn bool QSet::iterator::operator==(const iterator &other) const \fn bool QSet::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!=() */ @@ -805,8 +805,8 @@ \fn bool QSet::iterator::operator!=(const iterator &other) const \fn bool QSet::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==() */ diff --git a/src/corelib/tools/qshareddata.cpp b/src/corelib/tools/qshareddata.cpp index 0afda357a6..941e58ee7c 100644 --- a/src/corelib/tools/qshareddata.cpp +++ b/src/corelib/tools/qshareddata.cpp @@ -315,12 +315,12 @@ QT_BEGIN_NAMESPACE */ /*! \fn bool QSharedDataPointer::operator==(const QSharedDataPointer& other) const - Returns true if \a other and \e this have the same \e{d pointer}. + Returns \c true if \a other and \e this have the same \e{d pointer}. This function does \e not call detach(). */ /*! \fn bool QSharedDataPointer::operator!=(const QSharedDataPointer& other) const - Returns true if \a other and \e this do \e not have the same + Returns \c true if \a other and \e this do \e not have the same \e{d pointer}. This function does \e not call detach(). */ @@ -372,7 +372,7 @@ QT_BEGIN_NAMESPACE */ /*! \fn bool QSharedDataPointer::operator!() const - Returns true if the \e{d pointer} of \e this is null. + Returns \c true if the \e{d pointer} of \e this is null. */ /*! \fn void QSharedDataPointer::detach() @@ -479,7 +479,7 @@ QT_BEGIN_NAMESPACE */ /*! \fn bool QExplicitlySharedDataPointer::operator==(const QExplicitlySharedDataPointer& other) const - Returns true if \a other and \e this have the same \e{d pointer}. + Returns \c true if \a other and \e this have the same \e{d pointer}. */ /*! @@ -491,16 +491,16 @@ QT_BEGIN_NAMESPACE */ /*! \fn bool QExplicitlySharedDataPointer::operator==(const T* ptr) const - Returns true if the \e{d pointer} of \e this is \a ptr. + Returns \c true if the \e{d pointer} of \e this is \a ptr. */ /*! \fn bool QExplicitlySharedDataPointer::operator!=(const QExplicitlySharedDataPointer& other) const - Returns true if \a other and \e this do \e not have the same + Returns \c true if \a other and \e this do \e not have the same \e{d pointer}. */ /*! \fn bool QExplicitlySharedDataPointer::operator!=(const T* ptr) const - Returns true if the \e{d pointer} of \e this is \e not \a ptr. + Returns \c true if the \e{d pointer} of \e this is \e not \a ptr. */ /*! \fn QExplicitlySharedDataPointer::QExplicitlySharedDataPointer() @@ -569,11 +569,11 @@ QT_BEGIN_NAMESPACE */ /*! \fn QExplicitlySharedDataPointer::operator bool () const - Returns true if the \e{d pointer} of \e this is \e not null. + Returns \c true if the \e{d pointer} of \e this is \e not null. */ /*! \fn bool QExplicitlySharedDataPointer::operator!() const - Returns true if the \e{d pointer} of \e this is null. + Returns \c true if the \e{d pointer} of \e this is null. */ /*! \fn void QExplicitlySharedDataPointer::detach() diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp index ef62621386..77409f5c71 100644 --- a/src/corelib/tools/qsharedpointer.cpp +++ b/src/corelib/tools/qsharedpointer.cpp @@ -506,14 +506,14 @@ /*! \fn bool QSharedPointer::isNull() const - Returns true if this object is holding a reference to a null + Returns \c true if this object is holding a reference to a null pointer. */ /*! \fn QSharedPointer::operator bool() const - Returns true if this object is not null. This function is suitable + Returns \c true if this object is not null. This function is suitable for use in \tt if-constructs, like: \code @@ -526,7 +526,7 @@ /*! \fn bool QSharedPointer::operator !() const - Returns true if this object is null. This function is suitable + Returns \c true if this object is null. This function is suitable for use in \tt if-constructs, like: \code @@ -765,7 +765,7 @@ /*! \fn bool QWeakPointer::isNull() const - Returns true if this object is holding a reference to a null + Returns \c true if this object is holding a reference to a null pointer. Note that, due to the nature of weak references, the pointer that @@ -777,7 +777,7 @@ /*! \fn QWeakPointer::operator bool() const - Returns true if this object is not null. This function is suitable + Returns \c true if this object is not null. This function is suitable for use in \tt if-constructs, like: \code @@ -795,7 +795,7 @@ /*! \fn bool QWeakPointer::operator !() const - Returns true if this object is null. This function is suitable + Returns \c true if this object is null. This function is suitable for use in \tt if-constructs, like: \code @@ -896,7 +896,7 @@ \fn bool operator==(const QSharedPointer &ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -910,7 +910,7 @@ \fn bool operator!=(const QSharedPointer &ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -924,7 +924,7 @@ \fn bool operator==(const QSharedPointer &ptr1, const X *ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as \a ptr2. If \a ptr2's type is different from \a ptr1's, @@ -938,7 +938,7 @@ \fn bool operator!=(const QSharedPointer &ptr1, const X *ptr2) \relates QSharedPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as \a ptr2. If \a ptr2's type is different from \a ptr1's, @@ -952,7 +952,7 @@ \fn bool operator==(const T *ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer \a ptr1 is the + Returns \c true if the pointer \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's type, @@ -966,7 +966,7 @@ \fn bool operator!=(const T *ptr1, const QSharedPointer &ptr2) \relates QSharedPointer - Returns true if the pointer \a ptr1 is not the + Returns \c true if the pointer \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's type, @@ -980,7 +980,7 @@ \fn bool operator==(const QSharedPointer &ptr1, const QWeakPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -994,7 +994,7 @@ \fn bool operator!=(const QSharedPointer &ptr1, const QWeakPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -1008,7 +1008,7 @@ \fn bool operator==(const QWeakPointer &ptr1, const QSharedPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is the + Returns \c true if the pointer referenced by \a ptr1 is the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, @@ -1022,7 +1022,7 @@ \fn bool operator!=(const QWeakPointer &ptr1, const QSharedPointer &ptr2) \relates QWeakPointer - Returns true if the pointer referenced by \a ptr1 is not the + Returns \c true if the pointer referenced by \a ptr1 is not the same pointer as that referenced by \a ptr2. If \a ptr2's template parameter is different from \a ptr1's, diff --git a/src/corelib/tools/qsize.cpp b/src/corelib/tools/qsize.cpp index 6faeb9af0e..b53eced298 100644 --- a/src/corelib/tools/qsize.cpp +++ b/src/corelib/tools/qsize.cpp @@ -62,8 +62,8 @@ QT_BEGIN_NAMESPACE The isValid() function determines if a size is valid (a valid size has both width and height greater than zero). The isEmpty() - function returns true if either of the width and height is less - than, or equal to, zero, while the isNull() function returns true + function returns \c true if either of the width and height is less + than, or equal to, zero, while the isNull() function returns \c true only if both the width and the height is zero. Use the expandedTo() function to retrieve a size which holds the @@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE \fn QSize::QSize() Constructs a size with an invalid width and height (i.e., isValid() - returns false). + returns \c false). \sa isValid() */ @@ -102,7 +102,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QSize::isNull() const - Returns true if both the width and height is 0; otherwise returns + Returns \c true if both the width and height is 0; otherwise returns false. \sa isValid(), isEmpty() @@ -111,8 +111,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QSize::isEmpty() const - Returns true if either of the width and height is less than or - equal to 0; otherwise returns false. + Returns \c true if either of the width and height is less than or + equal to 0; otherwise returns \c false. \sa isNull(), isValid() */ @@ -120,8 +120,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QSize::isValid() const - Returns true if both the width and height is equal to or greater - than 0; otherwise returns false. + Returns \c true if both the width and height is equal to or greater + than 0; otherwise returns \c false. \sa isNull(), isEmpty() */ @@ -308,14 +308,14 @@ QSize QSize::scaled(const QSize &s, Qt::AspectRatioMode mode) const \fn bool operator==(const QSize &s1, const QSize &s2) \relates QSize - Returns true if \a s1 and \a s2 are equal; otherwise returns false. + Returns \c true if \a s1 and \a s2 are equal; otherwise returns \c false. */ /*! \fn bool operator!=(const QSize &s1, const QSize &s2) \relates QSize - Returns true if \a s1 and \a s2 are different; otherwise returns false. + Returns \c true if \a s1 and \a s2 are different; otherwise returns \c false. */ /*! @@ -470,9 +470,9 @@ QDebug operator<<(QDebug dbg, const QSize &s) { The isValid() function determines if a size is valid. A valid size has both width and height greater than or equal to zero. The - isEmpty() function returns true if either of the width and height + isEmpty() function returns \c true if either of the width and height is \e less than (or equal to) zero, while the isNull() function - returns true only if both the width and the height is zero. + returns \c true only if both the width and the height is zero. Use the expandedTo() function to retrieve a size which holds the maximum height and width of this size and a given @@ -519,7 +519,7 @@ QDebug operator<<(QDebug dbg, const QSize &s) { /*! \fn bool QSizeF::isNull() const - Returns true if both the width and height are +0.0; otherwise returns + Returns \c true if both the width and height are +0.0; otherwise returns false. \note Since this function treats +0.0 and -0.0 differently, sizes with @@ -532,8 +532,8 @@ QDebug operator<<(QDebug dbg, const QSize &s) { /*! \fn bool QSizeF::isEmpty() const - Returns true if either of the width and height is less than or - equal to 0; otherwise returns false. + Returns \c true if either of the width and height is less than or + equal to 0; otherwise returns \c false. \sa isNull(), isValid() */ @@ -541,8 +541,8 @@ QDebug operator<<(QDebug dbg, const QSize &s) { /*! \fn bool QSizeF::isValid() const - Returns true if both the width and height is equal to or greater - than 0; otherwise returns false. + Returns \c true if both the width and height is equal to or greater + than 0; otherwise returns \c false. \sa isNull(), isEmpty() */ @@ -737,7 +737,7 @@ QSizeF QSizeF::scaled(const QSizeF &s, Qt::AspectRatioMode mode) const \fn bool operator==(const QSizeF &s1, const QSizeF &s2) \relates QSizeF - Returns true if \a s1 and \a s2 are equal; otherwise returns + Returns \c true if \a s1 and \a s2 are equal; otherwise returns false. */ @@ -745,7 +745,7 @@ QSizeF QSizeF::scaled(const QSizeF &s, Qt::AspectRatioMode mode) const \fn bool operator!=(const QSizeF &s1, const QSizeF &s2) \relates QSizeF - Returns true if \a s1 and \a s2 are different; otherwise returns false. + Returns \c true if \a s1 and \a s2 are different; otherwise returns \c false. */ /*! diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 1ba9e81b59..8519eaa17a 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -2160,8 +2160,8 @@ QString &QString::replace(QChar c, QLatin1String after, Qt::CaseSensitivity cs) /*! \relates QString - Returns true if string \a s1 is equal to string \a s2; otherwise - returns false. + Returns \c true if string \a s1 is equal to string \a s2; otherwise + returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -2229,8 +2229,8 @@ bool QString::operator==(QLatin1String other) const /*! \relates QString - Returns true if string \a s1 is lexically less than string - \a s2; otherwise returns false. + Returns \c true if string \a s1 is lexically less than string + \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -2292,8 +2292,8 @@ bool QString::operator<(QLatin1String other) const /*! \fn bool QString::operator<=(const QString &s1, const QString &s2) - Returns true if string \a s1 is lexically less than or equal to - string \a s2; otherwise returns false. + Returns \c true if string \a s1 is lexically less than or equal to + string \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -2335,8 +2335,8 @@ bool QString::operator<(QLatin1String other) const /*! \fn bool QString::operator>(const QString &s1, const QString &s2) - Returns true if string \a s1 is lexically greater than string \a - s2; otherwise returns false. + Returns \c true if string \a s1 is lexically greater than string \a + s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -2395,8 +2395,8 @@ bool QString::operator>(QLatin1String other) const /*! \fn bool operator>=(const QString &s1, const QString &s2) \relates QString - Returns true if string \a s1 is lexically greater than or equal to - string \a s2; otherwise returns false. + Returns \c true if string \a s1 is lexically greater than or equal to + string \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -2439,8 +2439,8 @@ bool QString::operator>(QLatin1String other) const /*! \fn bool operator!=(const QString &s1, const QString &s2) \relates QString - Returns true if string \a s1 is not equal to string \a s2; - otherwise returns false. + Returns \c true if string \a s1 is not equal to string \a s2; + otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -3146,8 +3146,8 @@ int QString::count(const QStringRef &str, Qt::CaseSensitivity cs) const /*! \fn bool QString::contains(const QString &str, Qt::CaseSensitivity cs = Qt::CaseSensitive) const - Returns true if this string contains an occurrence of the string - \a str; otherwise returns false. + Returns \c true if this string contains an occurrence of the string + \a str; otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -3162,15 +3162,15 @@ int QString::count(const QStringRef &str, Qt::CaseSensitivity cs) const \overload contains() - Returns true if this string contains an occurrence of the - character \a ch; otherwise returns false. + Returns \c true if this string contains an occurrence of the + character \a ch; otherwise returns \c false. */ /*! \fn bool QString::contains(const QStringRef &str, Qt::CaseSensitivity cs = Qt::CaseSensitive) const \since 4.8 - Returns true if this string contains an occurrence of the string - reference \a str; otherwise returns false. + Returns \c true if this string contains an occurrence of the string + reference \a str; otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -3182,16 +3182,16 @@ int QString::count(const QStringRef &str, Qt::CaseSensitivity cs) const \overload contains() - Returns true if the regular expression \a rx matches somewhere in - this string; otherwise returns false. + Returns \c true if the regular expression \a rx matches somewhere in + this string; otherwise returns \c false. */ /*! \fn bool QString::contains(QRegExp &rx) const \overload contains() \since 4.5 - Returns true if the regular expression \a rx matches somewhere in - this string; otherwise returns false. + Returns \c true if the regular expression \a rx matches somewhere in + this string; otherwise returns \c false. If there is a match, the \a rx regular expression will contain the matched captures (see QRegExp::matchedLength, QRegExp::cap). @@ -3366,8 +3366,8 @@ int QString::lastIndexOf(const QRegularExpression &re, int from) const /*! \overload contains() \since 5.0 - Returns true if the regular expression \a re matches somewhere in - this string; otherwise returns false. + Returns \c true if the regular expression \a re matches somewhere in + this string; otherwise returns \c false. */ bool QString::contains(const QRegularExpression &re) const { @@ -3383,8 +3383,8 @@ bool QString::contains(const QRegularExpression &re) const \overload contains() \since 5.1 - Returns true if the regular expression \a re matches somewhere in this - string; otherwise returns false. + Returns \c true if the regular expression \a re matches somewhere in this + string; otherwise returns \c false. If the match is successful and \a match is not a null pointer, it also writes the results of the match into the QRegularExpressionMatch object @@ -3769,7 +3769,7 @@ QString QString::mid(int position, int n) const } /*! - Returns true if the string starts with \a s; otherwise returns + Returns \c true if the string starts with \a s; otherwise returns false. If \a cs is Qt::CaseSensitive (default), the search is @@ -3796,7 +3796,7 @@ bool QString::startsWith(QLatin1String s, Qt::CaseSensitivity cs) const /*! \overload startsWith() - Returns true if the string starts with \a c; otherwise returns + Returns \c true if the string starts with \a c; otherwise returns false. */ bool QString::startsWith(QChar c, Qt::CaseSensitivity cs) const @@ -3810,8 +3810,8 @@ bool QString::startsWith(QChar c, Qt::CaseSensitivity cs) const /*! \since 4.8 \overload - Returns true if the string starts with the string reference \a s; - otherwise returns false. + Returns \c true if the string starts with the string reference \a s; + otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -3825,7 +3825,7 @@ bool QString::startsWith(const QStringRef &s, Qt::CaseSensitivity cs) const } /*! - Returns true if the string ends with \a s; otherwise returns + Returns \c true if the string ends with \a s; otherwise returns false. If \a cs is Qt::CaseSensitive (default), the search is case @@ -3844,8 +3844,8 @@ bool QString::endsWith(const QString& s, Qt::CaseSensitivity cs) const /*! \since 4.8 \overload endsWith() - Returns true if the string ends with the string reference \a s; - otherwise returns false. + Returns \c true if the string ends with the string reference \a s; + otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -3868,7 +3868,7 @@ bool QString::endsWith(QLatin1String s, Qt::CaseSensitivity cs) const } /*! - Returns true if the string ends with \a c; otherwise returns + Returns \c true if the string ends with \a c; otherwise returns false. \overload endsWith() @@ -4632,7 +4632,7 @@ QString& QString::fill(QChar ch, int size) /*! \fn bool QString::isNull() const - Returns true if this string is null; otherwise returns false. + Returns \c true if this string is null; otherwise returns \c false. Example: @@ -4648,7 +4648,7 @@ QString& QString::fill(QChar ch, int size) /*! \fn bool QString::isEmpty() const - Returns true if the string has no characters; otherwise returns + Returns \c true if the string has no characters; otherwise returns false. Example: @@ -4751,7 +4751,7 @@ QString& QString::fill(QChar ch, int size) \overload operator==() \relates QString - Returns true if \a s1 is equal to \a s2; otherwise returns false. + Returns \c true if \a s1 is equal to \a s2; otherwise returns \c false. Note that no string is equal to \a s1 being 0. Equivalent to \c {s1 != 0 && compare(s1, s2) == 0}. @@ -4763,7 +4763,7 @@ QString& QString::fill(QChar ch, int size) \fn bool operator!=(const char *s1, const QString &s2) \relates QString - Returns true if \a s1 is not equal to \a s2; otherwise returns + Returns \c true if \a s1 is not equal to \a s2; otherwise returns false. For \a s1 != 0, this is equivalent to \c {compare(} \a s1, \a s2 @@ -4776,8 +4776,8 @@ QString& QString::fill(QChar ch, int size) \fn bool operator<(const char *s1, const QString &s2) \relates QString - Returns true if \a s1 is lexically less than \a s2; otherwise - returns false. For \a s1 != 0, this is equivalent to \c + Returns \c true if \a s1 is lexically less than \a s2; otherwise + returns \c false. For \a s1 != 0, this is equivalent to \c {compare(s1, s2) < 0}. The comparison is based exclusively on the numeric Unicode values @@ -4792,8 +4792,8 @@ QString& QString::fill(QChar ch, int size) \fn bool operator<=(const char *s1, const QString &s2) \relates QString - Returns true if \a s1 is lexically less than or equal to \a s2; - otherwise returns false. For \a s1 != 0, this is equivalent to \c + Returns \c true if \a s1 is lexically less than or equal to \a s2; + otherwise returns \c false. For \a s1 != 0, this is equivalent to \c {compare(s1, s2) <= 0}. The comparison is based exclusively on the numeric Unicode values @@ -4808,8 +4808,8 @@ QString& QString::fill(QChar ch, int size) \fn bool operator>(const char *s1, const QString &s2) \relates QString - Returns true if \a s1 is lexically greater than \a s2; otherwise - returns false. Equivalent to \c {compare(s1, s2) > 0}. + Returns \c true if \a s1 is lexically greater than \a s2; otherwise + returns \c false. Equivalent to \c {compare(s1, s2) > 0}. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -4823,8 +4823,8 @@ QString& QString::fill(QChar ch, int size) \fn bool operator>=(const char *s1, const QString &s2) \relates QString - Returns true if \a s1 is lexically greater than or equal to \a s2; - otherwise returns false. For \a s1 != 0, this is equivalent to \c + Returns \c true if \a s1 is lexically greater than or equal to \a s2; + otherwise returns \c false. For \a s1 != 0, this is equivalent to \c {compare(s1, s2) >= 0}. The comparison is based exclusively on the numeric Unicode values @@ -7430,7 +7430,7 @@ bool QString::isSimpleText() const /*! \fn bool QString::isRightToLeft() const - Returns true if the string is read right to left. + Returns \c true if the string is read right to left. */ bool QString::isRightToLeft() const { @@ -7708,8 +7708,8 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool QLatin1String::operator==(const QString &other) const - Returns true if this string is equal to string \a other; - otherwise returns false. + Returns \c true if this string is equal to string \a other; + otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -7733,8 +7733,8 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool QLatin1String::operator!=(const QString &other) const - Returns true if this string is not equal to string \a other; - otherwise returns false. + Returns \c true if this string is not equal to string \a other; + otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -7759,8 +7759,8 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool QLatin1String::operator>(const QString &other) const - Returns true if this string is lexically greater than string \a - other; otherwise returns false. + Returns \c true if this string is lexically greater than string \a + other; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -7785,8 +7785,8 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool QLatin1String::operator<(const QString &other) const - Returns true if this string is lexically less than the \a other - string; otherwise returns false. + Returns \c true if this string is lexically less than the \a other + string; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -7811,8 +7811,8 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool QLatin1String::operator>=(const QString &other) const - Returns true if this string is lexically greater than or equal - to string \a other; otherwise returns false. + Returns \c true if this string is lexically greater than or equal + to string \a other; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -7836,8 +7836,8 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool QLatin1String::operator<=(const QString &other) const - Returns true if this string is lexically less than or equal - to string \a other; otherwise returns false. + Returns \c true if this string is lexically less than or equal + to string \a other; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -7864,38 +7864,38 @@ QString &QString::setRawData(const QChar *unicode, int size) /*! \fn bool operator==(QLatin1String s1, QLatin1String s2) \relates QLatin1String - Returns true if string \a s1 is lexically equal to string \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically equal to string \a s2; otherwise + returns \c false. */ /*! \fn bool operator!=(QLatin1String s1, QLatin1String s2) \relates QLatin1String - Returns true if string \a s1 is lexically unequal to string \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically unequal to string \a s2; otherwise + returns \c false. */ /*! \fn bool operator<(QLatin1String s1, QLatin1String s2) \relates QLatin1String - Returns true if string \a s1 is lexically smaller than string \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically smaller than string \a s2; otherwise + returns \c false. */ /*! \fn bool operator<=(QLatin1String s1, QLatin1String s2) \relates QLatin1String - Returns true if string \a s1 is lexically smaller than or equal to string \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically smaller than or equal to string \a s2; otherwise + returns \c false. */ /*! \fn bool operator>(QLatin1String s1, QLatin1String s2) \relates QLatin1String - Returns true if string \a s1 is lexically greater than string \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically greater than string \a s2; otherwise + returns \c false. */ /*! \fn bool operator>=(QLatin1String s1, QLatin1String s2) \relates QLatin1String - Returns true if string \a s1 is lexically greater than or equal to - string \a s2; otherwise returns false. + Returns \c true if string \a s1 is lexically greater than or equal to + string \a s2; otherwise returns \c false. */ @@ -8120,7 +8120,7 @@ ownership of it, no memory is freed when instances are destroyed. /*! \fn bool QStringRef::isEmpty() const - Returns true if the string reference has no characters; otherwise returns + Returns \c true if the string reference has no characters; otherwise returns false. A string reference is empty if its size is zero. @@ -8131,8 +8131,8 @@ ownership of it, no memory is freed when instances are destroyed. /*! \fn bool QStringRef::isNull() const - Returns true if string() returns a null pointer or a pointer to a - null string; otherwise returns true. + Returns \c true if string() returns a null pointer or a pointer to a + null string; otherwise returns \c true. \sa size() */ @@ -8191,8 +8191,8 @@ QString QStringRef::toString() const { /*! \relates QStringRef - Returns true if string reference \a s1 is lexically equal to string reference \a s2; otherwise - returns false. + Returns \c true if string reference \a s1 is lexically equal to string reference \a s2; otherwise + returns \c false. */ bool operator==(const QStringRef &s1,const QStringRef &s2) { return (s1.size() == s2.size() && @@ -8201,8 +8201,8 @@ bool operator==(const QStringRef &s1,const QStringRef &s2) /*! \relates QStringRef - Returns true if string \a s1 is lexically equal to string reference \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically equal to string reference \a s2; otherwise + returns \c false. */ bool operator==(const QString &s1,const QStringRef &s2) { return (s1.size() == s2.size() && @@ -8211,8 +8211,8 @@ bool operator==(const QString &s1,const QStringRef &s2) /*! \relates QStringRef - Returns true if string \a s1 is lexically equal to string reference \a s2; otherwise - returns false. + Returns \c true if string \a s1 is lexically equal to string reference \a s2; otherwise + returns \c false. */ bool operator==(QLatin1String s1, const QStringRef &s2) { @@ -8237,8 +8237,8 @@ bool operator==(QLatin1String s1, const QStringRef &s2) /*! \relates QStringRef - Returns true if string reference \a s1 is lexically less than - string reference \a s2; otherwise returns false. + Returns \c true if string reference \a s1 is lexically less than + string reference \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -8254,8 +8254,8 @@ bool operator<(const QStringRef &s1,const QStringRef &s2) \relates QStringRef - Returns true if string reference \a s1 is lexically less than - or equal to string reference \a s2; otherwise returns false. + Returns \c true if string reference \a s1 is lexically less than + or equal to string reference \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -8267,8 +8267,8 @@ bool operator<(const QStringRef &s1,const QStringRef &s2) \relates QStringRef - Returns true if string reference \a s1 is lexically greater than - or equal to string reference \a s2; otherwise returns false. + Returns \c true if string reference \a s1 is lexically greater than + or equal to string reference \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -8280,8 +8280,8 @@ bool operator<(const QStringRef &s1,const QStringRef &s2) \relates QStringRef - Returns true if string reference \a s1 is lexically greater than - string reference \a s2; otherwise returns false. + Returns \c true if string reference \a s1 is lexically greater than + string reference \a s2; otherwise returns \c false. The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would @@ -8914,8 +8914,8 @@ int QStringRef::count(const QStringRef &str, Qt::CaseSensitivity cs) const /*! \since 4.8 - Returns true if the string reference starts with \a str; otherwise - returns false. + Returns \c true if the string reference starts with \a str; otherwise + returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -8953,8 +8953,8 @@ bool QStringRef::startsWith(const QStringRef &str, Qt::CaseSensitivity cs) const \since 4.8 \overload startsWith() - Returns true if the string reference starts with \a ch; otherwise - returns false. + Returns \c true if the string reference starts with \a ch; otherwise + returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -8975,8 +8975,8 @@ bool QStringRef::startsWith(QChar ch, Qt::CaseSensitivity cs) const /*! \since 4.8 - Returns true if the string reference ends with \a str; otherwise - returns false. + Returns \c true if the string reference ends with \a str; otherwise + returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -8993,8 +8993,8 @@ bool QStringRef::endsWith(const QString &str, Qt::CaseSensitivity cs) const \since 4.8 \overload endsWith() - Returns true if the string reference ends with \a ch; otherwise - returns false. + Returns \c true if the string reference ends with \a ch; otherwise + returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -9039,8 +9039,8 @@ bool QStringRef::endsWith(const QStringRef &str, Qt::CaseSensitivity cs) const /*! \fn bool QStringRef::contains(const QString &str, Qt::CaseSensitivity cs = Qt::CaseSensitive) const \since 4.8 - Returns true if this string reference contains an occurrence of - the string \a str; otherwise returns false. + Returns \c true if this string reference contains an occurrence of + the string \a str; otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -9053,8 +9053,8 @@ bool QStringRef::endsWith(const QStringRef &str, Qt::CaseSensitivity cs) const \overload contains() \since 4.8 - Returns true if this string contains an occurrence of the - character \a ch; otherwise returns false. + Returns \c true if this string contains an occurrence of the + character \a ch; otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -9065,8 +9065,8 @@ bool QStringRef::endsWith(const QStringRef &str, Qt::CaseSensitivity cs) const \overload contains() \since 4.8 - Returns true if this string reference contains an occurrence of - the string reference \a str; otherwise returns false. + Returns \c true if this string reference contains an occurrence of + the string reference \a str; otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. @@ -9078,8 +9078,8 @@ bool QStringRef::endsWith(const QStringRef &str, Qt::CaseSensitivity cs) const \since 4,8 \overload contains() - Returns true if this string reference contains an occurrence of - the string \a str; otherwise returns false. + Returns \c true if this string reference contains an occurrence of + the string \a str; otherwise returns \c false. If \a cs is Qt::CaseSensitive (default), the search is case sensitive; otherwise the search is case insensitive. diff --git a/src/corelib/tools/qstringlist.cpp b/src/corelib/tools/qstringlist.cpp index 870ac23028..46997b731c 100644 --- a/src/corelib/tools/qstringlist.cpp +++ b/src/corelib/tools/qstringlist.cpp @@ -283,8 +283,8 @@ QStringList QtPrivate::QStringList_filter(const QStringList *that, const QString /*! \fn bool QStringList::contains(const QString &str, Qt::CaseSensitivity cs) const - Returns true if the list contains the string \a str; otherwise - returns false. The search is case insensitive if \a cs is + Returns \c true if the list contains the string \a str; otherwise + returns \c false. The search is case insensitive if \a cs is Qt::CaseInsensitive; the search is case sensitive by default. \sa indexOf(), lastIndexOf(), QString::contains() diff --git a/src/corelib/tools/qtextboundaryfinder.cpp b/src/corelib/tools/qtextboundaryfinder.cpp index 7b8fbebb22..3063483da6 100644 --- a/src/corelib/tools/qtextboundaryfinder.cpp +++ b/src/corelib/tools/qtextboundaryfinder.cpp @@ -343,7 +343,7 @@ void QTextBoundaryFinder::setPosition(int position) /*! \fn bool QTextBoundaryFinder::isValid() const - Returns true if the text boundary finder is valid; otherwise returns false. + Returns \c true if the text boundary finder is valid; otherwise returns \c false. A default QTextBoundaryFinder is invalid. */ @@ -429,7 +429,7 @@ int QTextBoundaryFinder::toPreviousBoundary() } /*! - Returns true if the object's position() is currently at a valid text boundary. + Returns \c true if the object's position() is currently at a valid text boundary. */ bool QTextBoundaryFinder::isAtBoundary() const { diff --git a/src/corelib/tools/qtimezone.cpp b/src/corelib/tools/qtimezone.cpp index 762ad6fd09..b6196d99e5 100644 --- a/src/corelib/tools/qtimezone.cpp +++ b/src/corelib/tools/qtimezone.cpp @@ -432,7 +432,7 @@ QTimeZone &QTimeZone::operator=(const QTimeZone &other) */ /*! - Returns true if this time zone is equal to the \a other time zone. + Returns \c true if this time zone is equal to the \a other time zone. */ bool QTimeZone::operator==(const QTimeZone &other) const @@ -444,7 +444,7 @@ bool QTimeZone::operator==(const QTimeZone &other) const } /*! - Returns true if this time zone is not equal to the \a other time zone. + Returns \c true if this time zone is not equal to the \a other time zone. */ bool QTimeZone::operator!=(const QTimeZone &other) const @@ -456,7 +456,7 @@ bool QTimeZone::operator!=(const QTimeZone &other) const } /*! - Returns true if this time zone is valid. + Returns \c true if this time zone is valid. */ bool QTimeZone::isValid() const @@ -640,7 +640,7 @@ int QTimeZone::daylightTimeOffset(const QDateTime &atDateTime) const } /*! - Returns true if the time zone has observed daylight time at any time. + Returns \c true if the time zone has observed daylight time at any time. \sa isDaylightTime(), daylightTimeOffset() */ @@ -654,7 +654,7 @@ bool QTimeZone::hasDaylightTime() const } /*! - Returns true if the given \a atDateTime is in daylight time. + Returns \c true if the given \a atDateTime is in daylight time. \sa hasDaylightTime(), daylightTimeOffset() */ @@ -684,7 +684,7 @@ QTimeZone::OffsetData QTimeZone::offsetData(const QDateTime &forDateTime) const } /*! - Returns true if the system backend supports obtaining transitions. + Returns \c true if the system backend supports obtaining transitions. */ bool QTimeZone::hasTransitions() const @@ -769,7 +769,7 @@ QByteArray QTimeZone::systemTimeZoneId() } /*! - Returns true if a given time zone \a olsenId is available on this system. + Returns \c true if a given time zone \a olsenId is available on this system. \sa availableTimeZoneIds() */ diff --git a/src/corelib/tools/qvarlengtharray.qdoc b/src/corelib/tools/qvarlengtharray.qdoc index 4452bcf1cd..db435739fc 100644 --- a/src/corelib/tools/qvarlengtharray.qdoc +++ b/src/corelib/tools/qvarlengtharray.qdoc @@ -181,7 +181,7 @@ /*! \fn bool QVarLengthArray::isEmpty() const - Returns true if the array has size 0; otherwise returns false. + Returns \c true if the array has size 0; otherwise returns \c false. \sa size(), resize() */ @@ -627,7 +627,7 @@ \relates QVarLengthArray \since 4.8 - Returns true if the two arrays, specified by \a left and \a right, are equal. + Returns \c true if the two arrays, specified by \a left and \a right, are equal. Two arrays are considered equal if they contain the same values in the same order. @@ -642,7 +642,7 @@ \relates QVarLengthArray \since 4.8 - Returns true if the two arrays, specified by \a left and \a right, are \e not equal. + Returns \c true if the two arrays, specified by \a left and \a right, are \e not equal. Two arrays are considered equal if they contain the same values in the same order. diff --git a/src/corelib/tools/qvector.cpp b/src/corelib/tools/qvector.cpp index 8982e797d9..69b656c191 100644 --- a/src/corelib/tools/qvector.cpp +++ b/src/corelib/tools/qvector.cpp @@ -272,8 +272,8 @@ /*! \fn bool QVector::operator==(const QVector &other) const - Returns true if \a other is equal to this vector; otherwise - returns false. + Returns \c true if \a other is equal to this vector; otherwise + returns \c false. Two vectors are considered equal if they contain the same values in the same order. @@ -286,8 +286,8 @@ /*! \fn bool QVector::operator!=(const QVector &other) const - Returns true if \a other is not equal to this vector; otherwise - returns false. + Returns \c true if \a other is not equal to this vector; otherwise + returns \c false. Two vectors are considered equal if they contain the same values in the same order. @@ -307,7 +307,7 @@ /*! \fn bool QVector::isEmpty() const - Returns true if the vector has size 0; otherwise returns false. + Returns \c true if the vector has size 0; otherwise returns \c false. \sa size(), resize() */ @@ -649,8 +649,8 @@ /*! \fn bool QVector::contains(const T &value) const - Returns true if the vector contains an occurrence of \a value; - otherwise returns false. + Returns \c true if the vector contains an occurrence of \a value; + otherwise returns \c false. This function requires the value type to have an implementation of \c operator==(). @@ -661,8 +661,8 @@ /*! \fn bool QVector::startsWith(const T &value) const \since 4.5 - Returns true if this vector is not empty and its first - item is equal to \a value; otherwise returns false. + Returns \c true if this vector is not empty and its first + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), first() */ @@ -670,8 +670,8 @@ /*! \fn bool QVector::endsWith(const T &value) const \since 4.5 - Returns true if this vector is not empty and its last - item is equal to \a value; otherwise returns false. + Returns \c true if this vector is not empty and its last + item is equal to \a value; otherwise returns \c false. \sa isEmpty(), last() */ @@ -868,7 +868,7 @@ This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the vector is empty; otherwise - returns false. + returns \c false. */ /*! \fn QVector &QVector::operator+=(const QVector &other) -- cgit v1.2.3