Fix export, which has been broken since the boost::signals2 changes. Also update...
[ardour.git] / libs / audiographer / audiographer / source.h
index 8ffad204bad6f3574117d064609ef08f241d59f2..deefb900ee2b81b6f61dc7ca01ea559d1d91086c 100644 (file)
@@ -9,6 +9,9 @@
 namespace AudioGrapher
 {
 
+/** A source for data
+  * This is a pure virtual interface for all data sources in AudioGrapher
+  */
 template<typename T>
 class Source
 {
@@ -17,8 +20,13 @@ class Source
        
        typedef boost::shared_ptr<Sink<T> > SinkPtr;
        
+       /// Adds an output to this source. All data generated is forwarded to \a output
        virtual void add_output (SinkPtr output) = 0;
+       
+       /// Removes all outputs added
        virtual void clear_outputs () = 0;
+       
+       /// Removes a specific output from this source
        virtual void remove_output (SinkPtr output) = 0;
 };