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

svn-id: r39236

graphics/iff.h

@@ -22,6 +22,11 @@
  * $Id$
  */
 
+/**
+ * Bitmap decoder used in engines:
+ *  - parallaction
+ *  - saga
+ */
 
 #ifndef GRAPHICS_IFF_H
 #define GRAPHICS_IFF_H

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
 

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
 

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

sound/adpcm.h

@@ -23,6 +23,14 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - agos
+ *  - saga
+ *  - scumm
+ *  - tinsel
+ */
+
 #ifndef SOUND_ADPCM_H
 #define SOUND_ADPCM_H
 

sound/aiff.h

@@ -23,6 +23,12 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - saga
+ *  - sword1
+ */
+
 #ifndef SOUND_AIFF_H
 #define SOUND_AIFF_H
 

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
 

sound/iff.h

@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - parallaction
+ */
+
 #ifndef SOUND_IFF_H
 #define SOUND_IFF_H
 

sound/mods/infogrames.h

@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - gob
+ */
+
 #ifndef SOUND_MODS_INFOGRAMES_H
 #define SOUND_MODS_INFOGRAMES_H
 

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
 

sound/mods/rjp1.h

@@ -23,6 +23,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - queen
+ */
+
 #ifndef SOUND_MODS_RJP1_H
 #define SOUND_MODS_RJP1_H
 

sound/mods/soundfx.h

@@ -21,6 +21,11 @@
  *
  */
 
+/**
+ * Sound decoder used in engines:
+ *  - cine
+ */
+
 #ifndef SOUND_MODS_SOUNDFX_H
 #define SOUND_MODS_SOUNDFX_H
 

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
 

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
 

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
 

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