From 4958b5862251e7106c9a2d5d8a71f2a737324f03 Mon Sep 17 00:00:00 2001
From: Max Horn
Date: Fri, 27 Apr 2007 19:50:45 +0000
Subject: Added a doxygen comment to makeProtrackerStream -- somebody who knows
 the code behind this please complete/enhance this

svn-id: r26616
---
 sound/mods/protracker.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/sound/mods/protracker.h b/sound/mods/protracker.h
index 939b336b2f..7fefddd20c 100644
--- a/sound/mods/protracker.h
+++ b/sound/mods/protracker.h
@@ -31,6 +31,17 @@ namespace Audio {
 
 class AudioStream;
 
+/*
+ * Factory function for ProTracker streams. Reads all data from the
+ * given ReadStream and creates an AudioStream from this. No reference
+ * to the 'stream' object is kept, so you can safely delete it after 
+ * invoking this factory.
+ * 
+ * @param stream	the ReadStream from which to read the ProTracker data
+ * @param rate		TODO
+ * @param stereo	TODO
+ * @return	a new AudioStream, or NULL, if an error occured
+ */
 AudioStream *makeProtrackerStream(Common::ReadStream *stream, int rate = 44100, bool stereo = true);
 
 } // End of namespace Audio
-- 
cgit v1.2.3