add comment to enhance that the input stream must be consumed
authorDavid ‘Bombe’ Roden <bombe@freenetproject.org>
Mon, 16 Jun 2008 20:46:31 +0000 (22:46 +0200)
committerDavid ‘Bombe’ Roden <bombe@freenetproject.org>
Mon, 16 Jun 2008 20:46:31 +0000 (22:46 +0200)
src/net/pterodactylus/fcp/AllData.java

index 818d1a8..bf2a232 100644 (file)
@@ -90,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
         */