add comment to enhance that the input stream must be consumed

[jFCPlib.git] / src / net / pterodactylus / fcp / AllData.java

diff --git a/src/net/pterodactylus/fcp/AllData.java b/src/net/pterodactylus/fcp/AllData.java
index 2f73909..bf2a232 100644 (file)
--- a/src/net/pterodactylus/fcp/AllData.java
+++ b/src/net/pterodactylus/fcp/AllData.java
@@ -31,7 +31,6 @@ import java.io.InputStream;
  * consumed, the payload is discarded!
  * 
  * @author <a href="mailto:dr@ina-germany.de">David Roden</a>
- * @version $Id$
  */
 public class AllData extends BaseMessage {
 
@@ -91,7 +90,9 @@ public class AllData extends BaseMessage {
        }
 
        /**
-        * Returns the payload input stream.
+        * Returns the payload input stream. You <strong>have</strong> consume the
+        * input stream before returning from the
+        * {@link FcpListener#receivedAllData(FcpConnection, AllData)} method!
         * 
         * @return The payload
         */