[Scummvm-cvs-logs] SF.net SVN: scummvm:[46136] scummvm/trunk/sound

[fingolfin at users.sourceforge.net]

Revision: 46136
          http://scummvm.svn.sourceforge.net/scummvm/?rev=46136&view=rev
Author:   fingolfin
Date:     2009-11-25 10:55:25 +0000 (Wed, 25 Nov 2009)

Log Message:
-----------
Fix 'randomly placed' doxygen comments (which lead to incorrect documentation, e.g. some of those ended up as doxygen comment for various namespaces, such as Common)

Modified Paths:
--------------
    scummvm/trunk/sound/adpcm.h
    scummvm/trunk/sound/aiff.h
    scummvm/trunk/sound/flac.h
    scummvm/trunk/sound/iff_sound.h
    scummvm/trunk/sound/mods/infogrames.h
    scummvm/trunk/sound/mods/protracker.h
    scummvm/trunk/sound/mods/rjp1.h
    scummvm/trunk/sound/mods/soundfx.h
    scummvm/trunk/sound/mp3.h
    scummvm/trunk/sound/vag.h
    scummvm/trunk/sound/voc.h
    scummvm/trunk/sound/vorbis.h
    scummvm/trunk/sound/wave.h

Modified: scummvm/trunk/sound/adpcm.h
===================================================================
--- scummvm/trunk/sound/adpcm.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/adpcm.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - saga

Modified: scummvm/trunk/sound/aiff.h
===================================================================
--- scummvm/trunk/sound/aiff.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/aiff.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - saga
  *  - sword1

Modified: scummvm/trunk/sound/flac.h
===================================================================
--- scummvm/trunk/sound/flac.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/flac.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - kyra

Modified: scummvm/trunk/sound/iff_sound.h
===================================================================
--- scummvm/trunk/sound/iff_sound.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/iff_sound.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - parallaction
  */

Modified: scummvm/trunk/sound/mods/infogrames.h
===================================================================
--- scummvm/trunk/sound/mods/infogrames.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/mods/infogrames.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - gob
  */

Modified: scummvm/trunk/sound/mods/protracker.h
===================================================================
--- scummvm/trunk/sound/mods/protracker.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/mods/protracker.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - parallaction

Modified: scummvm/trunk/sound/mods/rjp1.h
===================================================================
--- scummvm/trunk/sound/mods/rjp1.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/mods/rjp1.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - queen
  */

Modified: scummvm/trunk/sound/mods/soundfx.h
===================================================================
--- scummvm/trunk/sound/mods/soundfx.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/mods/soundfx.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -22,6 +22,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - cine
  */

Modified: scummvm/trunk/sound/mp3.h
===================================================================
--- scummvm/trunk/sound/mp3.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/mp3.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - kyra

Modified: scummvm/trunk/sound/vag.h
===================================================================
--- scummvm/trunk/sound/vag.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/vag.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -23,9 +23,11 @@
  *
  */
 
-/* Sound decoder used in engines:
- * sword1 (PSX port of the game)
- * sword2 (PSX port of the game)
+/**
+ * @file
+ * Sound decoder used in engines:
+ * - sword1 (PSX port of the game)
+ * - sword2 (PSX port of the game)
  */
 
 #ifndef SOUND_VAG_H

Modified: scummvm/trunk/sound/voc.h
===================================================================
--- scummvm/trunk/sound/voc.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/voc.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - drascula

Modified: scummvm/trunk/sound/vorbis.h
===================================================================
--- scummvm/trunk/sound/vorbis.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/vorbis.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - kyra

Modified: scummvm/trunk/sound/wave.h
===================================================================
--- scummvm/trunk/sound/wave.h	2009-11-25 08:07:20 UTC (rev 46135)
+++ scummvm/trunk/sound/wave.h	2009-11-25 10:55:25 UTC (rev 46136)
@@ -24,6 +24,7 @@
  */
 
 /**
+ * @file
  * Sound decoder used in engines:
  *  - agos
  *  - gob


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.