merge of '33b368d75d4b7536dd4a29efa35fba64e6dc409d'

and '8eb5a0d367c4b34eadc326e0ba727e998e6f5505'

merge of '33b368d75d4b7536dd4a29efa35fba64e6dc409d'
b875e284 · zzz · 46fe4298 · dcffde6e · b875e284 · b875e284
Commit b875e284 authored 10 years ago by zzz
--- a/apps/addressbook/java/src/net/i2p/addressbook/package.html
+++ b/apps/addressbook/java/src/net/i2p/addressbook/package.html
+<html>
+<body>
+<p>
+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.
+</p>
+</body>
+</html>
--- a/apps/i2psnark/java/src/org/klomp/snark/package.html
+++ b/apps/i2psnark/java/src/org/klomp/snark/package.html
+<html>
+<body>
+<p>
+I2P version of the snark bittorrent client, imported in 2005 and heavily enhanced
+to add a web UI, DHT support, and other features.
+</p>
+</body>
+</html>
--- a/apps/i2psnark/java/src/org/klomp/snark/web/package.html
+++ b/apps/i2psnark/java/src/org/klomp/snark/web/package.html
+<html>
+<body>
+<p>
+The i2psnark user interface, implemented as a webapp in i2psnark.war.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/irc/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/irc/package.html
+<html>
+<body>
+<p>
+Filters for the IRC client tunnel, and DCC handlers.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/localServer/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/localServer/package.html
+<html>
+<body>
+<p>
+A very simple HTTP server, used only for css and images on HTTP client proxy error pages.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/package.html
+<html>
+<body>
+<p>
+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.
+</p><p>
+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.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/socks/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/socks/package.html
+<html>
+<body>
+<p>
+SOCKS 4, 4a, and 5 client tunnels.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/streamr/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/streamr/package.html
+<html>
+<body>
+<p>
+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.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/udp/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/udp/package.html
+<html>
+<body>
+<p>
+A small API used by UDP tunnels.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/package.html
+<html>
+<body>
+<p>
+Classes for configuring tunnels, used externally by Android.
+Separated out of net.i2p.i2ptunnel.web as a publicly supported API in 0.9.19.
+</p>
+</body>
+</html>
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/web/package.html
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/web/package.html
+<html>
+<body>
+<p>
+The UI for adding tunnels and editing their configurations,
+implemented as a webapp packaged in i2ptunnel.war.
+Not be maintained as a stable API.
+</p>
+</body>
+</html>
--- a/apps/routerconsole/java/src/net/i2p/router/web/package.html
+++ b/apps/routerconsole/java/src/net/i2p/router/web/package.html
+<html>
+<body>
+<p>
+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.
+</p>
+</body>
+</html>
--- a/apps/sam/java/src/net/i2p/sam/package.html
+++ b/apps/sam/java/src/net/i2p/sam/package.html
+<html>
+<body>
+<p>
+The SAM client API.
+</p>
+</body>
+</html>
--- a/apps/susidns/src/java/src/i2p/susi/dns/package.html
+++ b/apps/susidns/src/java/src/i2p/susi/dns/package.html
+<html>
+<body>
+<p>
+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.
+</p>
+</body>
+</html>
--- a/apps/susimail/src/src/i2p/susi/webmail/package.html
+++ b/apps/susimail/src/src/i2p/susi/webmail/package.html
+<html>
+<body>
+<p>
+The SusiMail webapp, which implements a webmail interface,
+POP3 and SMTP client-side protocols, and local caching of email.
+</p>
+</body>
+</html>
--- a/apps/systray/java/src/net/i2p/apps/systray/package.html
+++ b/apps/systray/java/src/net/i2p/apps/systray/package.html
+<html>
+<body>
+<p>
+A system tray control for launching the I2P router console.
+</p>
+</body>
+</html>