[Scummvm-cvs-logs] SF.net SVN: scummvm: [26616] scummvm/trunk/sound/mods/protracker.h

[fingolfin at users.sourceforge.net]

Revision: 26616
          http://scummvm.svn.sourceforge.net/scummvm/?rev=26616&view=rev
Author:   fingolfin
Date:     2007-04-27 12:50:45 -0700 (Fri, 27 Apr 2007)

Log Message:
-----------
Added a doxygen comment to makeProtrackerStream -- somebody who knows the code behind this please complete/enhance this

Modified Paths:
--------------
    scummvm/trunk/sound/mods/protracker.h

Modified: scummvm/trunk/sound/mods/protracker.h
===================================================================
--- scummvm/trunk/sound/mods/protracker.h	2007-04-27 18:54:33 UTC (rev 26615)
+++ scummvm/trunk/sound/mods/protracker.h	2007-04-27 19:50:45 UTC (rev 26616)
@@ -31,6 +31,17 @@
 
 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


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.