[Scummvm-cvs-logs] scummvm master -> 6a1fa88b56b9f94cfefcae189dec5263493c4c74

[clone2727]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
6a1fa88b56 VIDEO: Clarify some VideoDecoder documentation


Commit: 6a1fa88b56b9f94cfefcae189dec5263493c4c74
    https://github.com/scummvm/scummvm/commit/6a1fa88b56b9f94cfefcae189dec5263493c4c74
Author: Matthew Hoops (clone2727 at gmail.com)
Date: 2012-11-14T10:35:16-08:00

Commit Message:
VIDEO: Clarify some VideoDecoder documentation

Changed paths:
    video/video_decoder.h



diff --git a/video/video_decoder.h b/video/video_decoder.h
index cc7d1df..860caec 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() {}