diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
| commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
| tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/tools/qdoc/yyindent.cpp | |
| parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/tools/qdoc/yyindent.cpp')
| -rw-r--r-- | src/tools/qdoc/yyindent.cpp | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/tools/qdoc/yyindent.cpp b/src/tools/qdoc/yyindent.cpp index 08ac0dfe3b1..9d7a66a55a7 100644 --- a/src/tools/qdoc/yyindent.cpp +++ b/src/tools/qdoc/yyindent.cpp @@ -148,8 +148,8 @@ static QChar firstNonWhiteSpace( const QString& t ) } /* - Returns true if string t is made only of white space; otherwise - returns false. + Returns \c true if string t is made only of white space; otherwise + returns \c false. */ static bool isOnlyWhiteSpace( const QString& t ) { @@ -283,8 +283,8 @@ static inline QChar lastParen( const QString& t ) } /* - Returns true if typedIn the same as okayCh or is null; otherwise - returns false. + Returns \c true if typedIn the same as okayCh or is null; otherwise + returns \c false. */ static inline bool okay( QChar typedIn, QChar okayCh ) { @@ -456,9 +456,9 @@ static void startLinizer() } /* - Returns true if the start of the bottom line of yyProgram (and + Returns \c true if the start of the bottom line of yyProgram (and potentially the whole line) is part of a C-style comment; - otherwise returns false. + otherwise returns \c false. */ static bool bottomLineStartsInCComment() { @@ -526,15 +526,15 @@ static int indentWhenBottomLineStartsInCComment() /* A function called match...() modifies the linizer state. If it - returns true, yyLine is the top line of the matched construct; + returns \c true, yyLine is the top line of the matched construct; otherwise, the linizer is left in an unknown state. A function called is...() keeps the linizer state intact. */ /* - Returns true if the current line (and upwards) forms a braceless - control statement; otherwise returns false. + Returns \c true if the current line (and upwards) forms a braceless + control statement; otherwise returns \c false. The first line of the following example is a "braceless control statement": @@ -614,7 +614,7 @@ static bool matchBracelessControlStatement() } /* - Returns true if yyLine is an unfinished line; otherwise returns + Returns \c true if yyLine is an unfinished line; otherwise returns false. In many places we'll use the terms "standalone line", "unfinished @@ -669,7 +669,7 @@ static bool isUnfinishedLine() } /* - Returns true if yyLine is a continuation line; otherwise returns + Returns \c true if yyLine is a continuation line; otherwise returns false. */ static bool isContinuationLine() |