From e6717aaf43c7a25d426502a6d5d7028d50aab255 Mon Sep 17 00:00:00 2001
From: Matthew Hoops
Date: Thu, 27 Feb 2014 21:27:24 -0500
Subject: IMAGE: Clarify difference between ImageDecoder and Codec a bit

---
 image/codecs/codec.h | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'image/codecs')

diff --git a/image/codecs/codec.h b/image/codecs/codec.h
index c84f3e3308..1b7a295e9d 100644
--- a/image/codecs/codec.h
+++ b/image/codecs/codec.h
@@ -33,8 +33,16 @@ class SeekableReadStream;
 namespace Image {
 
 /**
- * An abstract representation of a video codec used for decoding
- * video frames.
+ * An abstract representation of a image codec.
+ *
+ * Unlike ImageDecoder, the entire info for a frame may not be present
+ * within the stream. The codec may rely on the supporting container
+ * for parameters and can also rely on a previous (or future) frame.
+ * When decoding, the previous frame may not destroyed and could be
+ * maintained for use in the next one.
+ *
+ * An ImageDecoder can always be a Codec, but a Codec may not necessarily
+ * be able to be an ImageDecoder.
  *
  * Used in video:
  *  - AVIDecoder
-- 
cgit v1.2.3