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/gui/text/qtextdocumentwriter.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/gui/text/qtextdocumentwriter.cpp')
| -rw-r--r-- | src/gui/text/qtextdocumentwriter.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/gui/text/qtextdocumentwriter.cpp b/src/gui/text/qtextdocumentwriter.cpp index a294bceacc..1722a791b9 100644 --- a/src/gui/text/qtextdocumentwriter.cpp +++ b/src/gui/text/qtextdocumentwriter.cpp @@ -88,7 +88,7 @@ public: later. Call write() to write the document to the device. If the document is - successfully written, this function returns true. However, if an error + successfully written, this function returns \c true. However, if an error occurs when writing the document, it will return false. Call supportedDocumentFormats() for a list of formats that @@ -245,7 +245,7 @@ QString QTextDocumentWriter::fileName () const /*! Writes the given \a document to the assigned device or file and - returns true if successful; otherwise returns false. + returns \c true if successful; otherwise returns \c false. */ bool QTextDocumentWriter::write(const QTextDocument *document) { @@ -304,7 +304,7 @@ bool QTextDocumentWriter::write(const QTextDocument *document) /*! Writes the document fragment specified by \a fragment to the assigned device - or file and returns true if successful; otherwise returns false. + or file and returns \c true if successful; otherwise returns \c false. */ bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment) { |