Don’t connect sources and sinks directly, use a pipeline to move data around.

[sonitus.git] / src / main / java / net / pterodactylus / sonitus / data / Filter.java

diff --git a/src/main/java/net/pterodactylus/sonitus/data/Filter.java b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
index d0bad5d..c6fab7e 100644 (file)
--- a/src/main/java/net/pterodactylus/sonitus/data/Filter.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
@@ -18,7 +18,8 @@
 package net.pterodactylus.sonitus.data;
 
 /**
- * A filter processes an input to produce an output.
+ * A filter is both a {@link Source} and a {@link Sink}. It is used to process
+ * the audio date in whatever way seems appropriate.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */