echelon/i2p.i2p
1
0
Fork 0
forked from I2P_Developers/i2p.i2p
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Javadoc: missing package.html files in applications (ticket #1109)

Browse Source
This commit is contained in:
zzz
2015-03-22 18:37:40 +00:00
parent 78074f6a7e
commit dcffde6eeb
16 changed files with 134 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
apps/addressbook/java/src/net/i2p/addressbook/package.html Normal file
View File

@ -0,0 +1,11 @@
<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>

8
apps/i2psnark/java/src/org/klomp/snark/package.html Normal file
View File

@ -0,0 +1,8 @@
<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>

7
apps/i2psnark/java/src/org/klomp/snark/web/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
The i2psnark user interface, implemented as a webapp in i2psnark.war.
</p>
</body>
</html>

7
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/irc/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
Filters for the IRC client tunnel, and DCC handlers.
</p>
</body>
</html>

7
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/localServer/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
A very simple HTTP server, used only for css and images on HTTP client proxy error pages.
</p>
</body>
</html>

14
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/package.html Normal file
View File

@ -0,0 +1,14 @@
<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>

7
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/socks/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
SOCKS 4, 4a, and 5 client tunnels.
</p>
</body>
</html>

9
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/streamr/package.html Normal file
View File

@ -0,0 +1,9 @@
<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>

7
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/udp/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
A small API used by UDP tunnels.
</p>
</body>
</html>

8
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/package.html Normal file
View File

@ -0,0 +1,8 @@
<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>

9
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/web/package.html Normal file
View File

@ -0,0 +1,9 @@
<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>

9
apps/routerconsole/java/src/net/i2p/router/web/package.html Normal file
View File

@ -0,0 +1,9 @@
<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>

7
apps/sam/java/src/net/i2p/sam/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
The SAM client API.
</p>
</body>
</html>

9
apps/susidns/src/java/src/i2p/susi/dns/package.html Normal file
View File

@ -0,0 +1,9 @@
<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>

8
apps/susimail/src/src/i2p/susi/webmail/package.html Normal file
View File

@ -0,0 +1,8 @@
<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>

7
apps/systray/java/src/net/i2p/apps/systray/package.html Normal file
View File

@ -0,0 +1,7 @@
<html>
<body>
<p>
A system tray control for launching the I2P router console.
</p>
</body>
</html>