From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Wed, 5 Jun 2013 04:35:06 +0000 (+0200)
Subject: Update javadocs.
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=eacf380129e247dd03f7d054d67e34cb43658959;p=sonitus.git

Update javadocs.
---

diff --git a/src/main/java/net/pterodactylus/sonitus/data/Filter.java b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
index 2b27e9f..924ccee 100644
--- a/src/main/java/net/pterodactylus/sonitus/data/Filter.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
@@ -66,7 +66,7 @@ public interface Filter {
 	Metadata metadata();
 
 	/**
-	 * Notifies the sink that the metadata of the audio stream has changed. This
+	 * Notifies the filter that the metadata of the audio stream has changed. This
 	 * method should return as fast as possible, i.e. every heavy lifting should be
 	 * done from another thread.
 	 *
@@ -91,7 +91,7 @@ public interface Filter {
 	DataPacket get(int bufferSize) throws IOException;
 
 	/**
-	 * Opens this sink using the format parameters of the given metadata.
+	 * Opens this filter using the format parameters of the given metadata.
 	 *
 	 * @param metadata
 	 * 		The metadata of the stream
@@ -100,7 +100,7 @@ public interface Filter {
 	 */
 	void open(Metadata metadata) throws IOException;
 
-	/** Closes this sink. */
+	/** Closes this filter. */
 	void close();
 
 	/**
diff --git a/src/main/java/net/pterodactylus/sonitus/data/filter/RateLimitingFilter.java b/src/main/java/net/pterodactylus/sonitus/data/filter/RateLimitingFilter.java
index 609eb69..ff1a2f2 100644
--- a/src/main/java/net/pterodactylus/sonitus/data/filter/RateLimitingFilter.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/filter/RateLimitingFilter.java
@@ -27,8 +27,7 @@ import net.pterodactylus.sonitus.data.Metadata;
 
 /**
  * Rate limiting filter that only passes a specified amount of data per second
- * from its {@link net.pterodactylus.sonitus.data.Source} to its {@link
- * net.pterodactylus.sonitus.data.Sink}.
+ * from its source to its sinks.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
diff --git a/src/main/java/net/pterodactylus/sonitus/data/sink/FileSink.java b/src/main/java/net/pterodactylus/sonitus/data/sink/FileSink.java
index e8c550f..1b0a1ac 100644
--- a/src/main/java/net/pterodactylus/sonitus/data/sink/FileSink.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/sink/FileSink.java
@@ -23,11 +23,11 @@ import java.util.logging.Logger;
 
 import net.pterodactylus.sonitus.data.AbstractFilter;
 import net.pterodactylus.sonitus.data.DataPacket;
+import net.pterodactylus.sonitus.data.Filter;
 import net.pterodactylus.sonitus.data.Metadata;
 
 /**
- * {@link net.pterodactylus.sonitus.data.Sink} that writes all received data
- * into a file.
+ * {@link Filter} that writes all received data into a file.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
diff --git a/src/main/java/net/pterodactylus/sonitus/data/sink/Icecast2Sink.java b/src/main/java/net/pterodactylus/sonitus/data/sink/Icecast2Sink.java
index f13fef1..1c5a3b1 100644
--- a/src/main/java/net/pterodactylus/sonitus/data/sink/Icecast2Sink.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/sink/Icecast2Sink.java
@@ -39,8 +39,8 @@ import com.google.common.io.BaseEncoding;
 import com.google.common.io.Closeables;
 
 /**
- * {@link net.pterodactylus.sonitus.data.Sink} implementation that delivers all
- * incoming data to an Icecast2 server.
+ * {@link Filter} implementation that delivers all incoming data to an Icecast2
+ * server.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
diff --git a/src/main/java/net/pterodactylus/sonitus/data/source/StreamSource.java b/src/main/java/net/pterodactylus/sonitus/data/source/StreamSource.java
index c324857..8b0c518 100644
--- a/src/main/java/net/pterodactylus/sonitus/data/source/StreamSource.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/source/StreamSource.java
@@ -31,6 +31,7 @@ import net.pterodactylus.sonitus.data.AbstractFilter;
 import net.pterodactylus.sonitus.data.ContentMetadata;
 import net.pterodactylus.sonitus.data.Controller;
 import net.pterodactylus.sonitus.data.DataPacket;
+import net.pterodactylus.sonitus.data.Filter;
 import net.pterodactylus.sonitus.data.FormatMetadata;
 import net.pterodactylus.sonitus.data.Metadata;
 import net.pterodactylus.sonitus.io.MetadataStream;
@@ -40,7 +41,7 @@ import com.google.common.collect.Maps;
 import com.google.common.primitives.Ints;
 
 /**
- * {@link Source} implementation that can download an audio stream from a
+ * {@link Filter} implementation that can download an audio stream from a
  * streaming server.
  * <p/>
  * Currently only “audio/mpeg” (aka MP3) streams are supported.