summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qregexp.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/qregexp.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/qregexp.cpp')
-rw-r--r--src/corelib/tools/qregexp.cpp28
1 files changed, 14 insertions, 14 deletions
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(),