[Scummvm-cvs-logs] CVS: scummvm/sound midiparser.h,1.20,1.21 midiparser_smf.cpp,1.15,1.16 midiparser_xmidi.cpp,1.13,1.14

[Max Horn]

Update of /cvsroot/scummvm/scummvm/sound
In directory sc8-pr-cvs1:/tmp/cvs-serv30053/sound

Modified Files:
	midiparser.h midiparser_smf.cpp midiparser_xmidi.cpp 
Log Message:
cleanup / doxygenification

Index: midiparser.h
===================================================================
RCS file: /cvsroot/scummvm/scummvm/sound/midiparser.h,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -r1.20 -r1.21
--- midiparser.h	16 Aug 2003 17:08:21 -0000	1.20
+++ midiparser.h	3 Oct 2003 23:34:05 -0000	1.21
@@ -24,10 +24,9 @@
 #ifndef INCLUDED_MIDIPARSER
 #define INCLUDED_MIDIPARSER
 
-class MidiParser;
-
 #include "common/scummsys.h"
 
+class MidiParser;
 class MidiDriver;
 
 

Index: midiparser_smf.cpp
===================================================================
RCS file: /cvsroot/scummvm/scummvm/sound/midiparser_smf.cpp,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- midiparser_smf.cpp	14 Aug 2003 05:07:31 -0000	1.15
+++ midiparser_smf.cpp	3 Oct 2003 23:34:06 -0000	1.16
@@ -25,12 +25,9 @@
 #include "common/util.h"
 
 
-//////////////////////////////////////////////////
-//
-// The Standard MIDI File version of MidiParser
-//
-//////////////////////////////////////////////////
-
+/**
+ * The Standard MIDI File version of MidiParser.
+ */
 class MidiParser_SMF : public MidiParser {
 protected:
 	byte *_buffer;
@@ -49,15 +46,8 @@
 };
 
 
-
-//////////////////////////////////////////////////
-//
-// MidiParser_SMF implementation
-//
-//////////////////////////////////////////////////
-
-static byte command_lengths[8] = { 3, 3, 3, 3, 2, 2, 3, 0 };
-static byte special_lengths[16] = { 0, 1, 1, 3, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0 };
+static const byte command_lengths[8] = { 3, 3, 3, 3, 2, 2, 3, 0 };
+static const byte special_lengths[16] = { 0, 1, 1, 3, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0 };
 
 MidiParser_SMF::~MidiParser_SMF() {
 	if (_buffer)

Index: midiparser_xmidi.cpp
===================================================================
RCS file: /cvsroot/scummvm/scummvm/sound/midiparser_xmidi.cpp,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- midiparser_xmidi.cpp	18 Jun 2003 21:10:05 -0000	1.13
+++ midiparser_xmidi.cpp	3 Oct 2003 23:34:06 -0000	1.14
@@ -25,12 +25,12 @@
 #include "common/util.h"
 
 
-//////////////////////////////////////////////////
-//
-// The XMIDI version of MidiParser
-//
-//////////////////////////////////////////////////
-
+/**
+ * The XMIDI version of MidiParser.
+ * 
+ * Much of this code is adapted from the XMIDI implementation from the exult
+ * project.
+ */
 class MidiParser_XMIDI : public MidiParser {
 protected:
 	NoteTimer _notes_cache[32];
@@ -48,16 +48,6 @@
 	bool loadMusic (byte *data, uint32 size);
 };
 
-
-
-//////////////////////////////////////////////////
-//
-// MidiParser_XMIDI implementation
-//
-// Much of this code is adapted from the XMIDI
-// implementation from the exult project.
-//
-//////////////////////////////////////////////////
 
 // This is a special XMIDI variable length quantity
 uint32 MidiParser_XMIDI::readVLQ2 (byte * &pos) {