Update Build file with new builder features

[libs/al.git] / source / streamer.h

diff --git a/source/streamer.h b/source/streamer.h
index eddd49d7a067011b31561acbdd7abe6e904db892..7843e9e8a0497e265bda373c55a557e99fa2f4a0 100644 (file)
--- a/source/streamer.h
+++ b/source/streamer.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspal
-Copyright © 2008 Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_AL_STREAMER_H_
 #define MSP_AL_STREAMER_H_
 
@@ -17,11 +10,16 @@ namespace AL {
 class Sound;
 class Buffer;
 
+/**
+A streamer transfers data from a Sound to a Source.  It is permanently attached
+to the same Source, but can play multiple Sounds during its lifetime.  A single
+Sound can only be played by one Streamer at a time.
+*/
 class Streamer
 {
 private:
        Source &src;
-       Sound  *snd;
+       Sound *snd;
        std::list<Buffer *> buffers;
 
 public: