diff options
Diffstat (limited to 'src/corelib/tools/qstring.cpp')
| -rw-r--r-- | src/corelib/tools/qstring.cpp | 208 |
1 files changed, 104 insertions, 104 deletions
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. |