diff --git a/apps/addressbook/java/src/net/i2p/addressbook/package.html b/apps/addressbook/java/src/net/i2p/addressbook/package.html new file mode 100644 index 0000000000..cd44906578 --- /dev/null +++ b/apps/addressbook/java/src/net/i2p/addressbook/package.html @@ -0,0 +1,11 @@ + +
++The addressbook application, which fetches hosts.txt files from subscription URLS via +HTTP and adds new hosts to the local database. +While implemented as a webapp, this application contains no user interface. +May also be packaged as a jar, as is done for Android. +The webapp named 'addressbook' in the console is actually SusiDNS. +
+ + diff --git a/apps/i2psnark/java/src/org/klomp/snark/package.html b/apps/i2psnark/java/src/org/klomp/snark/package.html new file mode 100644 index 0000000000..a617ebef61 --- /dev/null +++ b/apps/i2psnark/java/src/org/klomp/snark/package.html @@ -0,0 +1,8 @@ + + ++I2P version of the snark bittorrent client, imported in 2005 and heavily enhanced +to add a web UI, DHT support, and other features. +
+ + diff --git a/apps/i2psnark/java/src/org/klomp/snark/web/package.html b/apps/i2psnark/java/src/org/klomp/snark/web/package.html new file mode 100644 index 0000000000..56fda906f5 --- /dev/null +++ b/apps/i2psnark/java/src/org/klomp/snark/web/package.html @@ -0,0 +1,7 @@ + + ++The i2psnark user interface, implemented as a webapp in i2psnark.war. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/irc/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/irc/package.html new file mode 100644 index 0000000000..3e40205e4a --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/irc/package.html @@ -0,0 +1,7 @@ + + ++Filters for the IRC client tunnel, and DCC handlers. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/localServer/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/localServer/package.html new file mode 100644 index 0000000000..dc8a69bae5 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/localServer/package.html @@ -0,0 +1,7 @@ + + ++A very simple HTTP server, used only for css and images on HTTP client proxy error pages. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/package.html new file mode 100644 index 0000000000..de517ffb49 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/package.html @@ -0,0 +1,14 @@ + + ++Implementation of preconfigured tunnels, both for clients and servers, +and a UI for adding more and editing the configuration. +Includes special-purpose tunnels for IRC, SOCKS, HTTP, and more. +
+The entry point is TunnelControllerGroup, which is started from clients.config. +Individual tunnel configuration is in i2ptunnel.config. +The primary API is TunnelControllerGroup and TunnelController. +Other classes may not be maintained as a stable API. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/socks/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/socks/package.html new file mode 100644 index 0000000000..a16de8b251 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/socks/package.html @@ -0,0 +1,7 @@ + + ++SOCKS 4, 4a, and 5 client tunnels. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/streamr/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/streamr/package.html new file mode 100644 index 0000000000..3f3f8173e4 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/streamr/package.html @@ -0,0 +1,9 @@ + + ++Special-purpose client and server tunnels for streaming UDP clients and servers, +generally for audio and video streaming. +Extends the base classes in net.i2p.i2ptunnel.udpTunnel. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/udp/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/udp/package.html new file mode 100644 index 0000000000..0eb89724e6 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/udp/package.html @@ -0,0 +1,7 @@ + + ++A small API used by UDP tunnels. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/package.html new file mode 100644 index 0000000000..93f5dc19c2 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/package.html @@ -0,0 +1,8 @@ + + ++Classes for configuring tunnels, used externally by Android. +Separated out of net.i2p.i2ptunnel.web as a publicly supported API in 0.9.19. +
+ + diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/web/package.html b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/web/package.html new file mode 100644 index 0000000000..61d2d3b567 --- /dev/null +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/web/package.html @@ -0,0 +1,9 @@ + + ++The UI for adding tunnels and editing their configurations, +implemented as a webapp packaged in i2ptunnel.war. +Not be maintained as a stable API. +
+ + diff --git a/apps/routerconsole/java/src/net/i2p/router/web/package.html b/apps/routerconsole/java/src/net/i2p/router/web/package.html new file mode 100644 index 0000000000..1926aa3944 --- /dev/null +++ b/apps/routerconsole/java/src/net/i2p/router/web/package.html @@ -0,0 +1,9 @@ + + ++The router console user interface, implemented in routerconsole.jar, with these classes +supporting the webapp in routerconsole.war. +Entry point is RouterConsoleRunner, started from clients.config. +
+ + diff --git a/apps/sam/java/src/net/i2p/sam/package.html b/apps/sam/java/src/net/i2p/sam/package.html new file mode 100644 index 0000000000..fc5bbd3c1f --- /dev/null +++ b/apps/sam/java/src/net/i2p/sam/package.html @@ -0,0 +1,7 @@ + + ++The SAM client API. +
+ + diff --git a/apps/susidns/src/java/src/i2p/susi/dns/package.html b/apps/susidns/src/java/src/i2p/susi/dns/package.html new file mode 100644 index 0000000000..065a70ea20 --- /dev/null +++ b/apps/susidns/src/java/src/i2p/susi/dns/package.html @@ -0,0 +1,9 @@ + + ++The SusiDNS webapp, which is the user interface for the addressbook application +and the local naming service (hosts database) implemented in net.i2p.client.naming. +This is the webapp named 'addressbook' in the console. +
+ + diff --git a/apps/susimail/src/src/i2p/susi/webmail/package.html b/apps/susimail/src/src/i2p/susi/webmail/package.html new file mode 100644 index 0000000000..60ba58cb40 --- /dev/null +++ b/apps/susimail/src/src/i2p/susi/webmail/package.html @@ -0,0 +1,8 @@ + + ++The SusiMail webapp, which implements a webmail interface, +POP3 and SMTP client-side protocols, and local caching of email. +
+ + diff --git a/apps/systray/java/src/net/i2p/apps/systray/package.html b/apps/systray/java/src/net/i2p/apps/systray/package.html new file mode 100644 index 0000000000..5698cb171b --- /dev/null +++ b/apps/systray/java/src/net/i2p/apps/systray/package.html @@ -0,0 +1,7 @@ + + ++A system tray control for launching the I2P router console. +
+ +