From 6a1fa88b56b9f94cfefcae189dec5263493c4c74 Mon Sep 17 00:00:00 2001
From: Matthew Hoops
Date: Wed, 14 Nov 2012 13:34:29 -0500
Subject: VIDEO: Clarify some VideoDecoder documentation

---
 video/video_decoder.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'video')

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() {}
 
-- 
cgit v1.2.3