Patch #2658710: "Add comments to specify which engines use which decoders"

svn-id: r39236

16 files changed, 131 insertions, 0 deletions

diff --git a/graphics/iff.h b/graphics/iff.h
index 1bda15c9d7..77674d35f3 100644
--- a/graphics/iff.h
+++ b/graphics/iff.h
@@ -22,6 +22,11 @@
  * $Id$
  */
 
+/**
+ * Bitmap decoder used in engines:
+ *  - parallaction
+ *  - saga
+ */
 
 #ifndef GRAPHICS_IFF_H
 #define GRAPHICS_IFF_H
diff --git a/graphics/video/dxa_player.h b/graphics/video/dxa_player.h
index 78825dc6f1..35ce86f181 100644
--- a/graphics/video/dxa_player.h
+++ b/graphics/video/dxa_player.h
@@ -23,6 +23,13 @@
  *
  */
 
+/**
+ * Video decoder used in engines:
+ *  - agos
+ *  - sword1
+ *  - sword2
+ */
+
 #ifndef GRAPHICS_VIDEO_DXA_PLAYER_H
 #define GRAPHICS_VIDEO_DXA_PLAYER_H
 
diff --git a/graphics/video/flic_player.h b/graphics/video/flic_player.h
index 40aa0f4fdf..f2a60811c9 100644
--- a/graphics/video/flic_player.h
+++ b/graphics/video/flic_player.h
@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Video decoder used in engines:
+ *  - tucker
+ */
+
 #ifndef GRAPHICS_VIDEO_FLICPLAYER_H
 #define GRAPHICS_VIDEO_FLICPLAYER_H
 
diff --git a/graphics/video/smk_player.h b/graphics/video/smk_player.h
index 6e7e0e88a9..d4c6050a5d 100644
--- a/graphics/video/smk_player.h
+++ b/graphics/video/smk_player.h
@@ -23,6 +23,15 @@
  *
  */
 
+/**
+ * Video decoder used in engines:
+ *  - agos
+ *  - saga
+ *  - scumm (he)
+ *  - sword1
+ *  - sword2
+ */
+
 // Based on http://wiki.multimedia.cx/index.php?title=Smacker
 // and the FFmpeg Smacker decoder (libavcodec/smacker.c), revision 16143
 // http://svn.ffmpeg.org/ffmpeg/trunk/libavcodec/smacker.c?revision=16143&view=markup
diff --git a/sound/adpcm.h b/sound/adpcm.h
index 886897014b..e54f03e55e 100644
--- a/sound/adpcm.h
+++ b/sound/adpcm.h
@@ -23,6 +23,14 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - saga
+ *  - scumm
+ *  - tinsel
+ */
+
 #ifndef SOUND_ADPCM_H
 #define SOUND_ADPCM_H
 
diff --git a/sound/aiff.h b/sound/aiff.h
index 334c19217c..78449e2434 100644
--- a/sound/aiff.h
+++ b/sound/aiff.h
@@ -23,6 +23,12 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - saga
+ *  - sword1
+ */
+
 #ifndef SOUND_AIFF_H
 #define SOUND_AIFF_H
 
diff --git a/sound/flac.h b/sound/flac.h
index 8a51441afd..3507123928 100644
--- a/sound/flac.h
+++ b/sound/flac.h
@@ -23,6 +23,20 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - kyra
+ *  - m4
+ *  - queen
+ *  - saga
+ *  - scumm
+ *  - sword1
+ *  - sword2
+ *  - touche
+ *  - tucker
+ */
+
 #ifndef SOUND_FLAC_H
 #define SOUND_FLAC_H
 
diff --git a/sound/iff.h b/sound/iff.h
index d7cddc80fc..2bc8b51b82 100644
--- a/sound/iff.h
+++ b/sound/iff.h
@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - parallaction
+ */
+
 #ifndef SOUND_IFF_H
 #define SOUND_IFF_H
 
diff --git a/sound/mods/infogrames.h b/sound/mods/infogrames.h
index d44ea0475c..56473e5d84 100644
--- a/sound/mods/infogrames.h
+++ b/sound/mods/infogrames.h
@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - gob
+ */
+
 #ifndef SOUND_MODS_INFOGRAMES_H
 #define SOUND_MODS_INFOGRAMES_H
 
diff --git a/sound/mods/protracker.h b/sound/mods/protracker.h
index ab3e042475..6b0af912e9 100644
--- a/sound/mods/protracker.h
+++ b/sound/mods/protracker.h
@@ -23,6 +23,12 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - parallaction
+ */
+
 #ifndef SOUND_MODS_PROTRACKER_H
 #define SOUND_MODS_PROTRACKER_H
 
diff --git a/sound/mods/rjp1.h b/sound/mods/rjp1.h
index 9a4947456e..7b5c2a14cd 100644
--- a/sound/mods/rjp1.h
+++ b/sound/mods/rjp1.h
@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - queen
+ */
+
 #ifndef SOUND_MODS_RJP1_H
 #define SOUND_MODS_RJP1_H
 
diff --git a/sound/mods/soundfx.h b/sound/mods/soundfx.h
index f94bd59f15..6b94ebf62f 100644
--- a/sound/mods/soundfx.h
+++ b/sound/mods/soundfx.h
@@ -21,6 +21,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - cine
+ */
+
 #ifndef SOUND_MODS_SOUNDFX_H
 #define SOUND_MODS_SOUNDFX_H
 
diff --git a/sound/mp3.h b/sound/mp3.h
index a27fc9dec5..08cf1639ec 100644
--- a/sound/mp3.h
+++ b/sound/mp3.h
@@ -23,6 +23,20 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - kyra
+ *  - m4
+ *  - queen
+ *  - saga
+ *  - scumm
+ *  - sword1
+ *  - sword2
+ *  - touche
+ *  - tucker
+ */
+
 #ifndef SOUND_MP3_H
 #define SOUND_MP3_H
 
diff --git a/sound/voc.h b/sound/voc.h
index f9f9d9d728..2b4796e048 100644
--- a/sound/voc.h
+++ b/sound/voc.h
@@ -23,6 +23,18 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - drascula
+ *  - igor
+ *  - kyra
+ *  - made
+ *  - saga
+ *  - scumm
+ *  - touche
+ */
+
 #ifndef SOUND_VOC_H
 #define SOUND_VOC_H
 
diff --git a/sound/vorbis.h b/sound/vorbis.h
index 012c33e310..710d168d86 100644
--- a/sound/vorbis.h
+++ b/sound/vorbis.h
@@ -23,6 +23,20 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - kyra
+ *  - m4
+ *  - queen
+ *  - saga
+ *  - scumm
+ *  - sword1
+ *  - sword2
+ *  - touche
+ *  - tucker
+ */
+
 #ifndef SOUND_VORBIS_H
 #define SOUND_VORBIS_H
 
diff --git a/sound/wave.h b/sound/wave.h
index 6b035bd722..cc3b463ba4 100644
--- a/sound/wave.h
+++ b/sound/wave.h
@@ -23,6 +23,17 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - gob
+ *  - saga
+ *  - scumm
+ *  - sword1
+ *  - sword2
+ *  - tucker
+ */
+
 #ifndef SOUND_WAVE_H
 #define SOUND_WAVE_H