aboutsummaryrefslogtreecommitdiff
path: root/image
diff options
context:
space:
mode:
authorMatthew Hoops2014-02-27 21:27:25 -0500
committerMatthew Hoops2014-02-28 00:32:06 -0500
commit57aa610f0c6199fbe41fc5de495356aa29fae6b8 (patch)
treef92d798c1591c98160155882cd360a00915ef687 /image
parentacec700c11040320122ed86cd5f1dad20de2d2a8 (diff)
downloadscummvm-rg350-57aa610f0c6199fbe41fc5de495356aa29fae6b8.tar.gz
scummvm-rg350-57aa610f0c6199fbe41fc5de495356aa29fae6b8.tar.bz2
scummvm-rg350-57aa610f0c6199fbe41fc5de495356aa29fae6b8.zip
IMAGE: Update comments
Diffstat (limited to 'image')
-rw-r--r--image/codecs/bmp_raw.h3
-rw-r--r--image/codecs/cdtoons.h3
-rw-r--r--image/codecs/cinepak.h4
-rw-r--r--image/codecs/codec.h4
-rw-r--r--image/codecs/indeo3.h3
-rw-r--r--image/codecs/mjpeg.h3
-rw-r--r--image/codecs/mpeg.h9
-rw-r--r--image/codecs/msrle.h3
-rw-r--r--image/codecs/msvideo1.h3
-rw-r--r--image/codecs/qtrle.h3
-rw-r--r--image/codecs/rpza.h3
-rw-r--r--image/codecs/smc.h3
-rw-r--r--image/codecs/svq1.h3
-rw-r--r--image/codecs/truemotion1.h3
-rw-r--r--image/jpeg.h6
15 files changed, 24 insertions, 32 deletions
diff --git a/image/codecs/bmp_raw.h b/image/codecs/bmp_raw.h
index d589d7ef22..99509a1708 100644
--- a/image/codecs/bmp_raw.h
+++ b/image/codecs/bmp_raw.h
@@ -30,8 +30,7 @@ namespace Image {
/**
* Bitmap raw image decoder.
*
- * Used in image:
- * - BitmapDecoder
+ * Used by BMP/AVI.
*/
class BitmapRawDecoder : public Codec {
public:
diff --git a/image/codecs/cdtoons.h b/image/codecs/cdtoons.h
index a75ce551c2..889ec3ea1d 100644
--- a/image/codecs/cdtoons.h
+++ b/image/codecs/cdtoons.h
@@ -41,8 +41,7 @@ struct CDToonsBlock {
/**
* Broderbund CDToons decoder.
*
- * Used in video:
- * - QuickTimeDecoder
+ * Used by PICT/QuickTime.
*/
class CDToonsDecoder : public Codec {
public:
diff --git a/image/codecs/cinepak.h b/image/codecs/cinepak.h
index 985fc91165..e9cd437730 100644
--- a/image/codecs/cinepak.h
+++ b/image/codecs/cinepak.h
@@ -62,9 +62,7 @@ struct CinepakFrame {
/**
* Cinepak decoder.
*
- * Used in video:
- * - AVIDecoder
- * - QuickTimeDecoder
+ * Used by BMP/AVI and PICT/QuickTime.
*/
class CinepakDecoder : public Codec {
public:
diff --git a/image/codecs/codec.h b/image/codecs/codec.h
index 89c8ec9bf5..d87758e65e 100644
--- a/image/codecs/codec.h
+++ b/image/codecs/codec.h
@@ -44,6 +44,10 @@ namespace Image {
* An ImageDecoder can always be a Codec, but a Codec may not necessarily
* be able to be an ImageDecoder.
*
+ * Used in image:
+ * - BitmapDecoder
+ * - PICTDecoder
+ *
* Used in video:
* - AVIDecoder
* - QuickTimeDecoder
diff --git a/image/codecs/indeo3.h b/image/codecs/indeo3.h
index f1b406d40d..0ff0265250 100644
--- a/image/codecs/indeo3.h
+++ b/image/codecs/indeo3.h
@@ -39,8 +39,9 @@ namespace Image {
/**
* Intel Indeo 3 decoder.
*
+ * Used by BMP/AVI.
+ *
* Used in video:
- * - AVIDecoder
* - VMDDecoder
*/
class Indeo3Decoder : public Codec {
diff --git a/image/codecs/mjpeg.h b/image/codecs/mjpeg.h
index 904b89d3ae..2db736c218 100644
--- a/image/codecs/mjpeg.h
+++ b/image/codecs/mjpeg.h
@@ -39,8 +39,7 @@ namespace Image {
/**
* Motion JPEG decoder.
*
- * Used in video:
- * - AVIDecoder
+ * Used by BMP/AVI.
*/
class MJPEGDecoder : public Codec {
public:
diff --git a/image/codecs/mpeg.h b/image/codecs/mpeg.h
index 7f231dd8b3..6cb10f21ac 100644
--- a/image/codecs/mpeg.h
+++ b/image/codecs/mpeg.h
@@ -62,10 +62,13 @@ namespace Graphics {
struct Surface;
}
-namespace Image {
-
-// MPEG 1/2 video decoder
+namespace Image {
+/**
+ * MPEG 1/2 video decoder.
+ *
+ * Used by BMP/AVI.
+ */
class MPEGDecoder : public Codec {
public:
MPEGDecoder();
diff --git a/image/codecs/msrle.h b/image/codecs/msrle.h
index a65ef1c41d..116b1bcbf6 100644
--- a/image/codecs/msrle.h
+++ b/image/codecs/msrle.h
@@ -30,8 +30,7 @@ namespace Image {
/**
* Microsoft Run-Length Encoding decoder.
*
- * Used in video:
- * - AVIDecoder
+ * Used by BMP/AVI.
*/
class MSRLEDecoder : public Codec {
public:
diff --git a/image/codecs/msvideo1.h b/image/codecs/msvideo1.h
index bdee5acbe5..2a6dcd0a9a 100644
--- a/image/codecs/msvideo1.h
+++ b/image/codecs/msvideo1.h
@@ -30,8 +30,7 @@ namespace Image {
/**
* Microsoft Video 1 decoder.
*
- * Used in video:
- * - AVIDecoder
+ * Used by BMP/AVI.
*/
class MSVideo1Decoder : public Codec {
public:
diff --git a/image/codecs/qtrle.h b/image/codecs/qtrle.h
index 7ef89537cf..b44a46c3e2 100644
--- a/image/codecs/qtrle.h
+++ b/image/codecs/qtrle.h
@@ -31,8 +31,7 @@ namespace Image {
/**
* QuickTime Run-Length Encoding decoder.
*
- * Used in video:
- * - QuickTimeDecoder
+ * Used by PICT/QuickTime.
*/
class QTRLEDecoder : public Codec {
public:
diff --git a/image/codecs/rpza.h b/image/codecs/rpza.h
index 62f4c02df5..d1dbbdb676 100644
--- a/image/codecs/rpza.h
+++ b/image/codecs/rpza.h
@@ -31,8 +31,7 @@ namespace Image {
/**
* Apple RPZA decoder.
*
- * Used in video:
- * - QuickTimeDecoder
+ * Used by PICT/QuickTime.
*/
class RPZADecoder : public Codec {
public:
diff --git a/image/codecs/smc.h b/image/codecs/smc.h
index 579d629a1c..655ff0a3bc 100644
--- a/image/codecs/smc.h
+++ b/image/codecs/smc.h
@@ -37,8 +37,7 @@ enum {
/**
* Apple SMC decoder.
*
- * Used in video:
- * - QuickTimeDecoder
+ * Used by PICT/QuickTime.
*/
class SMCDecoder : public Codec {
public:
diff --git a/image/codecs/svq1.h b/image/codecs/svq1.h
index 687f7615d4..236b810294 100644
--- a/image/codecs/svq1.h
+++ b/image/codecs/svq1.h
@@ -36,8 +36,7 @@ namespace Image {
/**
* Sorenson Vector Quantizer 1 decoder.
*
- * Used in video:
- * - QuickTimeDecoder
+ * Used by PICT/QuickTime.
*/
class SVQ1Decoder : public Codec {
public:
diff --git a/image/codecs/truemotion1.h b/image/codecs/truemotion1.h
index bb87dbc32c..12570f066c 100644
--- a/image/codecs/truemotion1.h
+++ b/image/codecs/truemotion1.h
@@ -35,8 +35,7 @@ namespace Image {
/**
* Duck TrueMotion 1 decoder.
*
- * Used in video:
- * - AVIDecoder
+ * Used by BMP/AVI.
*/
class TrueMotion1Decoder : public Codec {
public:
diff --git a/image/jpeg.h b/image/jpeg.h
index dea799c31f..ac0d22d129 100644
--- a/image/jpeg.h
+++ b/image/jpeg.h
@@ -27,11 +27,7 @@
* - mohawk
* - wintermute
*
- * Used in image:
- * - PICTDecoder
- *
- * Used in video:
- * - QuickTimeDecoder
+ * Used by PICT/QuickTime.
*/
#ifndef IMAGE_JPEG_H