aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Hoops2012-11-14 13:34:29 -0500
committerMatthew Hoops2012-11-14 13:35:16 -0500
commit6a1fa88b56b9f94cfefcae189dec5263493c4c74 (patch)
tree6e5fd121c23629bf43f9d6cd9ed75810aeac8a12
parent459752f20b28882f4960f8b67b1683d629cbab9d (diff)
downloadscummvm-rg350-6a1fa88b56b9f94cfefcae189dec5263493c4c74.tar.gz
scummvm-rg350-6a1fa88b56b9f94cfefcae189dec5263493c4c74.tar.bz2
scummvm-rg350-6a1fa88b56b9f94cfefcae189dec5263493c4c74.zip
VIDEO: Clarify some VideoDecoder documentation
-rw-r--r--video/video_decoder.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/video/video_decoder.h b/video/video_decoder.h
index cc7d1df51b..860caecafe 100644
--- a/video/video_decoder.h
+++ b/video/video_decoder.h
@@ -374,7 +374,8 @@ public:
protected:
/**
- * An abstract representation of a track in a movie.
+ * An abstract representation of a track in a movie. Since tracks here are designed
+ * to work independently, they should not reference any other track(s) in the video.
*/
class Track {
public:
@@ -685,9 +686,9 @@ protected:
/**
* Decode enough data for the next frame and enough audio to last that long.
*
- * This function is used by the decodeNextFrame() function. A subclass
+ * This function is used by this class' decodeNextFrame() function. A subclass
* of a Track may decide to just have its decodeNextFrame() function read
- * and decode the frame.
+ * and decode the frame, but only if it is the only track in the video.
*/
virtual void readNextPacket() {}