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/image/qimagewriter.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/image/qimagewriter.cpp')
-rw-r--r-- | src/gui/image/qimagewriter.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/gui/image/qimagewriter.cpp b/src/gui/image/qimagewriter.cpp index c502a01df5..e4065724be 100644 --- a/src/gui/image/qimagewriter.cpp +++ b/src/gui/image/qimagewriter.cpp @@ -58,7 +58,7 @@ object. Pass either a file name or a device pointer, and the image format to QImageWriter's constructor. You can then set several options, such as the gamma level (by calling setGamma()) - and quality (by calling setQuality()). canWrite() returns true if + and quality (by calling setQuality()). canWrite() returns \c true if QImageWriter can write the image (i.e., the image format is supported and the device is open for writing). Call write() to write the image to the device. @@ -554,7 +554,7 @@ void QImageWriter::setText(const QString &key, const QString &text) } /*! - Returns true if QImageWriter can write the image; i.e., the image + Returns \c true if QImageWriter can write the image; i.e., the image format is supported and the assigned device is open for reading. \sa write(), setDevice(), setFormat() @@ -580,7 +580,7 @@ bool QImageWriter::canWrite() const /*! Writes the image \a image to the assigned device or file - name. Returns true on success; otherwise returns false. If the + name. Returns \c true on success; otherwise returns \c false. If the operation fails, you can call error() to find the type of error that occurred, or errorString() to get a human readable description of the error. @@ -631,7 +631,7 @@ QString QImageWriter::errorString() const /*! \since 4.2 - Returns true if the writer supports \a option; otherwise returns + Returns \c true if the writer supports \a option; otherwise returns false. Different image formats support different options. Call this function to |