From c50d40b7bf0914c5a1a5da221cee146ab4aa2f63 Mon Sep 17 00:00:00 2001
From: Matthew Hoops
Date: Fri, 7 Sep 2012 14:50:21 -0400
Subject: AUDIO: Add some documentation to MidiParser_QT

---
 audio/midiparser_qt.h | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'audio/midiparser_qt.h')

diff --git a/audio/midiparser_qt.h b/audio/midiparser_qt.h
index 50234020a0..ac5f45ae34 100644
--- a/audio/midiparser_qt.h
+++ b/audio/midiparser_qt.h
@@ -27,6 +27,9 @@
 #include "common/array.h"
 #include "common/quicktime.h"
 
+/**
+ * The QuickTime MIDI version of MidiParser.
+ */
 class MidiParser_QT : public MidiParser, public Common::QuickTimeParser {
 public:
 	MidiParser_QT() {}
@@ -36,9 +39,19 @@ public:
 	bool loadMusic(byte *data, uint32 size);
 	void unloadMusic();
 
-	// Custom
+	/**
+	 * Load the MIDI from a 'Tune' resource
+	 */
 	bool loadFromTune(Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
+
+	/**
+	 * Load the MIDI from a QuickTime stream
+	 */
 	bool loadFromContainerStream(Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
+
+	/**
+	 * Load the MIDI from a QuickTime file
+	 */
 	bool loadFromContainerFile(const Common::String &fileName);
 
 protected:
-- 
cgit v1.2.3