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/qimagereader.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/qimagereader.cpp')
-rw-r--r-- | src/gui/image/qimagereader.cpp | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index 5c5b1fa0be..636d86991b 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -761,8 +761,8 @@ void QImageReader::setAutoDetectImageFormat(bool enabled) } /*! - Returns true if image format autodetection is enabled on this image - reader; otherwise returns false. By default, autodetection is enabled. + Returns \c true if image format autodetection is enabled on this image + reader; otherwise returns \c false. By default, autodetection is enabled. \sa setAutoDetectImageFormat() */ @@ -1089,7 +1089,7 @@ QColor QImageReader::backgroundColor() const /*! \since 4.1 - Returns true if the image format supports animation; + Returns \c true if the image format supports animation; otherwise, false is returned. \sa QMovie::supportedFormats() @@ -1104,15 +1104,15 @@ bool QImageReader::supportsAnimation() const } /*! - Returns true if an image can be read for the device (i.e., the + Returns \c true if an image can be read for the device (i.e., the image format is supported, and the device seems to contain valid - data); otherwise returns false. + data); otherwise returns \c false. canRead() is a lightweight function that only does a quick test to see if the image data is valid. read() may still return false - after canRead() returns true, if the image data is corrupt. + after canRead() returns \c true, if the image data is corrupt. - For images that support animation, canRead() returns false when + For images that support animation, canRead() returns \c false when all frames have been read. \sa read(), supportedImageFormats() @@ -1149,7 +1149,7 @@ QImage QImageReader::read() \overload Reads an image from the device into \a image, which must point to a - QImage. Returns true on success; otherwise, returns false. + QImage. Returns \c true on success; otherwise, returns \c false. If \a image has same format and size as the image data that is about to be read, this function may not need to allocate a new image before @@ -1393,7 +1393,7 @@ QString QImageReader::errorString() const /*! \since 4.2 - Returns true if the reader supports \a option; otherwise returns + Returns \c true if the reader supports \a option; otherwise returns false. Different image formats support different options. Call this function to |