From 3ab149a39937a8542a0e704944bd2a21b5122e5c Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Sat, 1 Feb 2014 12:37:45 +0000
Subject: [PATCH] streaming javadoc fixes
---
.../java/src/net/i2p/client/streaming/package.html | 9 ++++++---
.../java/src/net/i2p/client/streaming/impl/package.html | 4 +++-
build.xml | 2 +-
3 files changed, 10 insertions(+), 5 deletions(-)
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 3e2ce48750..b1168f632e 100644
--- a/apps/ministreaming/java/src/net/i2p/client/streaming/package.html
+++ b/apps/ministreaming/java/src/net/i2p/client/streaming/package.html
@@ -1,9 +1,9 @@
<html><body>
-<p>Implements a TCP-like (reliable, authenticated, in order) set of sockets for
+<p>API, interfaces, and factory for a TCP-like (reliable, authenticated, in order) set of sockets for
communicating over the IP-like (unreliable, unauthenticated, unordered) I2P
messages.
Note that this class is split across two jars, streaming.jar and ministreaming.jar.
-The interfaces and some very old code are in ministreaming.jar, but the
+The interfaces are in ministreaming.jar, but the
real work gets done in streaming.jar. Clients must have both jars
in their classpath.
Most clients will require (only) streaming.jar, ministreaming.jar, and i2p.jar
@@ -23,7 +23,10 @@ net.i2p.client.streaming.I2PServerSocket#accept} method, which will provide 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.</p>
-<p>There is a simple pair of demo applications available as well -
+<p>This package also contains the I2PSocketEepGet utility, which is an HTTP client
+that uses an existing I2PSocketManager.</p>
+
+<p>There is a simple pair of demo applications available in the test directory -
net.i2p.client.streaming.StreamSinkServer listens to a destination and dumps
the data from all sockets it accepts to individual files, while
net.i2p.client.streaming.StreamSinkClient connects to a particular destination
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html b/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html
index dbf1d2d02f..d629a68f98 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html
+++ b/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html
@@ -1,10 +1,12 @@
<html><body>
-<p>Implements a TCP-like (reliable, authenticated, in order) set of sockets for
+<p>Implementation of a TCP-like (reliable, authenticated, in order) set of sockets for
communicating over the IP-like (unreliable, unauthenticated, unordered) I2P
messages.
This is the streaming implementation (moved for ticket #1135 to here).
For the API (which you probably want), see ministreaming.
+Clients should not need to access anything in this package directly.
+Use the interfaces and factory in net.i2p.streaming.
Note that this class is split across two jars, streaming.jar and ministreaming.jar.
The interfaces and some code are in ministreaming.jar, but the
diff --git a/build.xml b/build.xml
index 81cfe97c81..432434a664 100644
--- a/build.xml
+++ b/build.xml
@@ -468,7 +468,7 @@
doctitle="I2P Javadocs for Release ${release.number} Build ${i2p.build.number}${build.extra}"
windowtitle="I2P Anonymous Network - Java Documentation - Version ${release.number}">
<group title="Core SDK (i2p.jar)" packages="net.i2p:net.i2p.*:net.i2p.client:net.i2p.client.*:net.i2p.internal:net.i2p.internal.*:freenet.support.CPUInformation:org.bouncycastle.oldcrypto:org.bouncycastle.oldcrypto.*:gnu.crypto.*:gnu.gettext:com.nettgryppa.security:net.metanotion:net.metanotion.*" />
- <group title="Streaming Library" packages="net.i2p.client.streaming" />
+ <group title="Streaming Library" packages="net.i2p.client.streaming:net.i2p.client.streaming.impl" />
<group title="Router" packages="net.i2p.router:net.i2p.router.*:net.i2p.data.i2np:org.cybergarage.*:org.freenetproject:org.xlattice.crypto.filters" />
<group title="Router Console" packages="net.i2p.router.web:net.i2p.router.update" />
<!-- apps and bridges starting here, alphabetical please -->
--
GitLab