diff options
| author | Matthew Hoops | 2012-09-07 14:50:21 -0400 |
|---|---|---|
| committer | Matthew Hoops | 2012-09-07 14:50:21 -0400 |
| commit | c50d40b7bf0914c5a1a5da221cee146ab4aa2f63 (patch) | |
| tree | e3ef5cf8b52704a4c11e56b557614c73f99946fb /audio/midiparser_qt.h | |
| parent | c882ef9dabbb69e569bd5861712cf4117794a9ae (diff) | |
| download | scummvm-rg350-c50d40b7bf0914c5a1a5da221cee146ab4aa2f63.tar.gz scummvm-rg350-c50d40b7bf0914c5a1a5da221cee146ab4aa2f63.tar.bz2 scummvm-rg350-c50d40b7bf0914c5a1a5da221cee146ab4aa2f63.zip | |
AUDIO: Add some documentation to MidiParser_QT
Diffstat (limited to 'audio/midiparser_qt.h')
| -rw-r--r-- | audio/midiparser_qt.h | 15 |
1 files changed, 14 insertions, 1 deletions
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: |