aboutsummaryrefslogtreecommitdiff
path: root/video/video_decoder.h
diff options
context:
space:
mode:
authorMatthew Hoops2012-08-23 22:44:02 -0400
committerMatthew Hoops2012-08-23 22:45:48 -0400
commit829c836e0b86edc07aed4ed1846ac19ba76c6788 (patch)
tree808113a03ff396f766f03eb1acaf53a38affa14d /video/video_decoder.h
parent6c155b6b36f77a932a54e9b01c08f938c73e24eb (diff)
downloadscummvm-rg350-829c836e0b86edc07aed4ed1846ac19ba76c6788.tar.gz
scummvm-rg350-829c836e0b86edc07aed4ed1846ac19ba76c6788.tar.bz2
scummvm-rg350-829c836e0b86edc07aed4ed1846ac19ba76c6788.zip
VIDEO: Update the isPlaying() comment
Diffstat (limited to 'video/video_decoder.h')
-rw-r--r--video/video_decoder.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/video/video_decoder.h b/video/video_decoder.h
index 5fba85358c..5abe1d917c 100644
--- a/video/video_decoder.h
+++ b/video/video_decoder.h
@@ -117,7 +117,11 @@ public:
/**
* Returns if the video is currently playing or not.
- * @todo Differentiate this function from endOfVideo()
+ *
+ * This is not equivalent to the inverse of endOfVideo(). A video keeps
+ * its playing status even after reaching the end of the video. This will
+ * return true after calling start() and will continue to return true
+ * until stop() (or close()) is called.
*/
bool isPlaying() const { return _isPlaying; }