From c5b289fb1fb24278b8d99bfb0e7b2fe68b477a63 Mon Sep 17 00:00:00 2001
From: jrandom
Date: Sun, 1 Aug 2004 18:47:12 +0000
Subject: [PATCH] javadoc fixes
---
.../java/src/net/i2p/client/streaming/StreamSinkServer.java | 2 +-
.../java/src/net/i2p/client/streaming/package.html | 6 ++++++
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/apps/ministreaming/java/src/net/i2p/client/streaming/StreamSinkServer.java b/apps/ministreaming/java/src/net/i2p/client/streaming/StreamSinkServer.java
index 832ee4ee9..faf5a86e1 100644
--- a/apps/ministreaming/java/src/net/i2p/client/streaming/StreamSinkServer.java
+++ b/apps/ministreaming/java/src/net/i2p/client/streaming/StreamSinkServer.java
@@ -16,7 +16,7 @@ import net.i2p.util.Log;
/**
* Listen to a destination, receiving any sockets and writing anything they
- * send to a new file.
+ * send to a new file. See the {@link #main}
*
*/
public class StreamSinkServer {
diff --git a/apps/ministreaming/java/src/net/i2p/client/streaming/package.html b/apps/ministreaming/java/src/net/i2p/client/streaming/package.html
index c5149275e..735135074 100644
--- a/apps/ministreaming/java/src/net/i2p/client/streaming/package.html
+++ b/apps/ministreaming/java/src/net/i2p/client/streaming/package.html
@@ -15,4 +15,10 @@ net.i2p.client.streaming.I2PServerSocket#accept} method, which will provide an
{@link net.i2p.client.streaming.I2PSocket} when a new one is available. If an
application wants to create a new stream to a peer, it should do so with the
appropriate {@link net.i2p.client.streaming.I2PSocketManager#connect} call.
+
+There is a simple pair of demo applications available as well - {@link
+net.i2p.client.streaming.StreamSinkServer} listens to a destination and dumps
+the data from all sockets it accepts to individual files, while {@link
+net.i2p.client.streaming.StreamSinkClient} connects to a particular destination
+and sends a specific amount of random data then disconnects.