From 79dc01f7e4a5611c5aa7a3e44b29ca317830dcba Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Sun, 22 Mar 2015 16:35:21 +0000
Subject: [PATCH] Javadoc: missing package.html files in router.jar (ticket
#1109)
---
build.xml | 2 +-
router/java/src/net/i2p/router/client/package.html | 9 +++++++++
router/java/src/net/i2p/router/message/package.html | 8 ++++++++
.../net/i2p/router/networkdb/kademlia/package.html | 9 +++++++++
.../java/src/net/i2p/router/networkdb/package.html | 7 +++++++
.../net/i2p/router/networkdb/reseed/package.html | 11 +++++++++++
.../net/i2p/router/transport/crypto/package.html | 7 +++++++
router/java/src/net/i2p/router/tunnel/package.html | 13 +++++++++++++
.../src/net/i2p/router/tunnel/pool/package.html | 11 +++++++++++
router/java/src/org/cybergarage/Dummy.java | 7 +++++++
router/java/src/org/cybergarage/package.html | 7 +++++++
router/java/src/org/freenetproject/package.html | 8 ++++++++
.../src/org/xlattice/crypto/filters/package.html | 7 +++++++
13 files changed, 105 insertions(+), 1 deletion(-)
create mode 100644 router/java/src/net/i2p/router/client/package.html
create mode 100644 router/java/src/net/i2p/router/message/package.html
create mode 100644 router/java/src/net/i2p/router/networkdb/kademlia/package.html
create mode 100644 router/java/src/net/i2p/router/networkdb/package.html
create mode 100644 router/java/src/net/i2p/router/networkdb/reseed/package.html
create mode 100644 router/java/src/net/i2p/router/transport/crypto/package.html
create mode 100644 router/java/src/net/i2p/router/tunnel/package.html
create mode 100644 router/java/src/net/i2p/router/tunnel/pool/package.html
create mode 100644 router/java/src/org/cybergarage/Dummy.java
create mode 100644 router/java/src/org/cybergarage/package.html
create mode 100644 router/java/src/org/freenetproject/package.html
create mode 100644 router/java/src/org/xlattice/crypto/filters/package.html
diff --git a/build.xml b/build.xml
index 16fd386910..5e513551b2 100644
--- a/build.xml
+++ b/build.xml
@@ -680,7 +680,7 @@
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.getopt:gnu.gettext:com.nettgryppa.security:net.metanotion:net.metanotion.*" />
<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:net.i2p.data.router:org.cybergarage.*:org.freenetproject:org.xlattice.crypto.filters" />
+ <group title="Router" packages="net.i2p.router:net.i2p.router.*:net.i2p.data.i2np:net.i2p.data.router:org.cybergarage:org.cybergarage.*:org.freenetproject:org.xlattice.crypto.filters" />
<group title="Router Console" packages="net.i2p.router.web:net.i2p.router.update:net.i2p.router.news" />
<!-- apps and bridges starting here, alphabetical please -->
<group title="Addressbook Application" packages="net.i2p.addressbook" />
diff --git a/router/java/src/net/i2p/router/client/package.html b/router/java/src/net/i2p/router/client/package.html
new file mode 100644
index 0000000000..a5194356b6
--- /dev/null
+++ b/router/java/src/net/i2p/router/client/package.html
@@ -0,0 +1,9 @@
+<html>
+<body>
+<p>
+Implements the router side of the I2CP interface,
+which is the API for applications to send and receive data through the router.
+The client side of the interface is implemented in net.i2p.client.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/message/package.html b/router/java/src/net/i2p/router/message/package.html
new file mode 100644
index 0000000000..94184efa77
--- /dev/null
+++ b/router/java/src/net/i2p/router/message/package.html
@@ -0,0 +1,8 @@
+<html>
+<body>
+<p>
+Creates and parses garlic messages.
+Creates the source routing for outbound messages.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/networkdb/kademlia/package.html b/router/java/src/net/i2p/router/networkdb/kademlia/package.html
new file mode 100644
index 0000000000..812838422a
--- /dev/null
+++ b/router/java/src/net/i2p/router/networkdb/kademlia/package.html
@@ -0,0 +1,9 @@
+<html>
+<body>
+<p>
+The network database, including implementation of floodfills.
+Database lookups, stores, exploration, and replies.
+Management of locally-generated RouterInfos and Leasesets.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/networkdb/package.html b/router/java/src/net/i2p/router/networkdb/package.html
new file mode 100644
index 0000000000..59eab83252
--- /dev/null
+++ b/router/java/src/net/i2p/router/networkdb/package.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>
+A couple of classes, but most things are in kademlia.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/networkdb/reseed/package.html b/router/java/src/net/i2p/router/networkdb/reseed/package.html
new file mode 100644
index 0000000000..e3848ed538
--- /dev/null
+++ b/router/java/src/net/i2p/router/networkdb/reseed/package.html
@@ -0,0 +1,11 @@
+<html>
+<body>
+<p>
+Fetching, validation, unpacking, and installation of RouterInfos from
+signed su3 files, unsigned zip files, and web indexes.
+Supports loading from clearnet via HTTP and HTTPS, and from local files.
+Automatic reseeding on first install and when references fall below a minimum value.
+Support for user-initiated reseeds and status feedback via the router console.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/transport/crypto/package.html b/router/java/src/net/i2p/router/transport/crypto/package.html
new file mode 100644
index 0000000000..6c4a94d2e7
--- /dev/null
+++ b/router/java/src/net/i2p/router/transport/crypto/package.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>
+DH key generation.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/tunnel/package.html b/router/java/src/net/i2p/router/tunnel/package.html
new file mode 100644
index 0000000000..368c544da5
--- /dev/null
+++ b/router/java/src/net/i2p/router/tunnel/package.html
@@ -0,0 +1,13 @@
+<html>
+<body>
+<p>
+All the work of managing locally created and participating tunnels,
+creating and handling tunnel messages, and their encryption.
+Deals with the five different types of tunnel hops:
+outbound gateway, outbound endpoint, inbound gateway, inbound endpoint, and middle hop.
+Distributes messages received for each type.
+Validation, queueing and throttling for each type.
+Tunnel build message handling is in the pool package.
+</p>
+</body>
+</html>
diff --git a/router/java/src/net/i2p/router/tunnel/pool/package.html b/router/java/src/net/i2p/router/tunnel/pool/package.html
new file mode 100644
index 0000000000..36c7ad1713
--- /dev/null
+++ b/router/java/src/net/i2p/router/tunnel/pool/package.html
@@ -0,0 +1,11 @@
+<html>
+<body>
+<p>
+Tunnel creation, tunnel build message handling. Peer selection for tunnels.
+Grouping of tunnels into inbound and outbound pools.
+Pool configuration. Adaptive tunnel build strategy.
+Build request throttling, acceptance, rejection, and dropping based on local
+statistics and conditions.
+</p>
+</body>
+</html>
diff --git a/router/java/src/org/cybergarage/Dummy.java b/router/java/src/org/cybergarage/Dummy.java
new file mode 100644
index 0000000000..a7d71c9ad2
--- /dev/null
+++ b/router/java/src/org/cybergarage/Dummy.java
@@ -0,0 +1,7 @@
+package org.cybergarage;
+
+/**
+ * Exists only to enable package.html to be included in javadoc.
+ * http://java.sun.com/j2se/javadoc/faq/index.html#packagewithoutjavafiles
+ */
+abstract class Dummy {}
diff --git a/router/java/src/org/cybergarage/package.html b/router/java/src/org/cybergarage/package.html
new file mode 100644
index 0000000000..379ce53a04
--- /dev/null
+++ b/router/java/src/org/cybergarage/package.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>
+The cybergarage cyberlink UPnP library version 3.0, with minor mods for I2P.
+</p>
+</body>
+</html>
diff --git a/router/java/src/org/freenetproject/package.html b/router/java/src/org/freenetproject/package.html
new file mode 100644
index 0000000000..5194226569
--- /dev/null
+++ b/router/java/src/org/freenetproject/package.html
@@ -0,0 +1,8 @@
+<html>
+<body>
+<p>
+Small classes used by net.i2p.transport.UPnP to interface with the org.cybergarage UPnP library,
+as imported from freenet.
+</p>
+</body>
+</html>
diff --git a/router/java/src/org/xlattice/crypto/filters/package.html b/router/java/src/org/xlattice/crypto/filters/package.html
new file mode 100644
index 0000000000..dea59c8d8e
--- /dev/null
+++ b/router/java/src/org/xlattice/crypto/filters/package.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>
+Bloom filter used by net.i2p.router.util.DecayingBloomFilter
+</p>
+</body>
+</html>
--
GitLab