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/widgets/widgets/qplaintextedit.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/widgets/widgets/qplaintextedit.cpp')
-rw-r--r-- | src/widgets/widgets/qplaintextedit.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/widgets/widgets/qplaintextedit.cpp b/src/widgets/widgets/qplaintextedit.cpp index 5a8da45a88..90f2e47cd3 100644 --- a/src/widgets/widgets/qplaintextedit.cpp +++ b/src/widgets/widgets/qplaintextedit.cpp @@ -1211,7 +1211,7 @@ void QPlainTextEditPrivate::ensureViewportLayouted() Users are only able to undo or redo actions if this property is true, and if there is an action that can be undone (or redone). - By default, this property is true. + By default, this property is \c true. */ /*! @@ -2332,11 +2332,11 @@ QRect QPlainTextEdit::cursorRect() const As with many text editors, the plain text editor widget can be configured to insert or overwrite existing text with new text entered by the user. - If this property is true, existing text is overwritten, character-for-character + If this property is \c true, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text. - By default, this property is false (new text does not overwrite existing text). + By default, this property is \c false (new text does not overwrite existing text). */ bool QPlainTextEdit::overwriteMode() const @@ -2435,7 +2435,7 @@ QMimeData *QPlainTextEdit::createMimeDataFromSelection() const } /*! - This function returns true if the contents of the MIME data object, specified + This function returns \c true if the contents of the MIME data object, specified by \a source, can be decoded and inserted into the document. It is called for example when during a drag operation the mouse enters this widget and it is necessary to determine whether it is possible to accept the drag. @@ -2747,8 +2747,8 @@ void QPlainTextEdit::setCenterOnScroll(bool enabled) /*! Finds the next occurrence of the string, \a exp, using the given - \a options. Returns true if \a exp was found and changes the - cursor to select the match; otherwise returns false. + \a options. Returns \c true if \a exp was found and changes the + cursor to select the match; otherwise returns \c false. */ bool QPlainTextEdit::find(const QString &exp, QTextDocument::FindFlags options) { |