diff options
| author | Andreas Aardal Hanssen <andreas.aardal.hanssen@nokia.com> | 2009-12-23 09:33:29 (GMT) |
|---|---|---|
| committer | Andreas Aardal Hanssen <andreas.aardal.hanssen@nokia.com> | 2009-12-23 12:27:47 (GMT) |
| commit | 51b042f821f593808290e049e49f2f8bcd611fb0 (patch) | |
| tree | 7458b9d4484444303282de1dd71603f263e6a96d | |
| parent | 6d9d6bf4b66127f7f24d22efa2fe6c24d05b3724 (diff) | |
| download | Qt-51b042f821f593808290e049e49f2f8bcd611fb0.zip Qt-51b042f821f593808290e049e49f2f8bcd611fb0.tar.gz Qt-51b042f821f593808290e049e49f2f8bcd611fb0.tar.bz2 | |
Docs: Amendments to latest changes to QImageReader docs.
Reviewed-by: Holger Hans Peter Freyther <zecke@selfish.org>
| -rw-r--r-- | src/gui/image/qimagereader.cpp | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index c5aa28b..7580446 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -1213,11 +1213,10 @@ bool QImageReader::jumpToImage(int imageNumber) } /*! - For image formats that support animation, this function returns - the number of times the animation should loop. In case of an - infinite animation or an error -1 is returned. To differentiate - an infinite animation from an error, canRead() should be called - before this function. + For image formats that support animation, this function returns the number + of times the animation should loop. If this function returns -1, it can + either mean the animation should loop forever, or that an error occurred. + If an error occurred, canRead() will return false. \sa supportsAnimation(), QImageIOHandler::loopCount(), canRead() */ @@ -1229,11 +1228,11 @@ int QImageReader::loopCount() const } /*! - For image formats that support animation, this function returns - the total number of images in the animation. + For image formats that support animation, this function returns the total + number of images in the animation. If the format does not support + animation, 0 is returned. - Certain animation formats do not support this feature, in which - case 0 is returned. In case of an error -1 is returned. + This function returns -1 if an error occurred. \sa supportsAnimation(), QImageIOHandler::imageCount(), canRead() */ @@ -1245,11 +1244,11 @@ int QImageReader::imageCount() const } /*! - For image formats that support animation, this function returns - the number of milliseconds to wait until displaying the next frame - in the animation. Otherwise, 0 is returned. + For image formats that support animation, this function returns the number + of milliseconds to wait until displaying the next frame in the animation. + If the image format doesn't support animation, 0 is returned. - In case of an error -1 is returned. + This function returns -1 if an error occurred. \sa supportsAnimation(), QImageIOHandler::nextImageDelay(), canRead() */ @@ -1261,11 +1260,11 @@ int QImageReader::nextImageDelay() const } /*! - For image formats that support animation, this function returns - the sequence number of the current frame. Otherwise, 0 is - returned. + For image formats that support animation, this function returns the + sequence number of the current frame. If the image format doesn't support + animation, 0 is returned. - In case of an error -1 is returned. + This function returns -1 if an error occurred. \sa supportsAnimation(), QImageIOHandler::currentImageNumber(), canRead() */ |