summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qregularexpression.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/tools/qregularexpression.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff)
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/corelib/tools/qregularexpression.cpp')
-rw-r--r--src/corelib/tools/qregularexpression.cpp22
1 files changed, 11 insertions, 11 deletions
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()
*/