From b44a56aa92c0411d034b71395b5f26494f367343 Mon Sep 17 00:00:00 2001
From: Filippos Karapetis
Date: Wed, 13 Jan 2010 08:14:16 +0000
Subject: Documented MidiParser_SCI, mentioning that it's an extension to the
 MidiParser_SMF parser

svn-id: r47287
---
 engines/sci/sound/midiparser_sci.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'engines/sci/sound/midiparser_sci.h')

diff --git a/engines/sci/sound/midiparser_sci.h b/engines/sci/sound/midiparser_sci.h
index 900b3006ea..5e62e2d7c3 100644
--- a/engines/sci/sound/midiparser_sci.h
+++ b/engines/sci/sound/midiparser_sci.h
@@ -45,6 +45,12 @@
 
 namespace Sci {
 
+/**
+ * An extended standard MIDI (SMF) parser. Sierra used an extra channel
+ * with special commands for extended functionality and animation syncing.
+ * Refer to MidiParser_SMF() in /sound/midiparser_smf.cpp for the standard
+ * MIDI (SMF) parser functionality that the SCI MIDI parser is based on
+ */
 class MidiParser_SCI : public MidiParser {
 public:
 	MidiParser_SCI(SciVersion soundVersion);
-- 
cgit v1.2.3