From e0e06d73ebe4ea8eed8b749fc9e1bca51c9f8780 Mon Sep 17 00:00:00 2001 From: zzz Date: Fri, 27 Jan 2017 03:14:34 +0000 Subject: [PATCH] javadoc fixes part 14 (ticket #1894) --- apps/BOB/src/net/i2p/BOB/BOB.java | 1 - apps/i2psnark/java/src/org/klomp/snark/BitField.java | 2 +- apps/i2psnark/java/src/org/klomp/snark/MagnetState.java | 4 ++-- .../java/src/org/klomp/snark/bencode/BDecoder.java | 2 +- apps/i2psnark/java/src/org/klomp/snark/dht/NodeInfo.java | 2 +- .../java/src/net/i2p/i2ptunnel/SSLClientUtil.java | 2 +- .../java/src/org/mortbay/servlet/MultiPartRequest.java | 2 +- .../java/src/net/i2p/router/web/GraphHelper.java | 2 +- .../java/src/net/i2p/router/web/SummaryHelper.java | 1 + .../java/src/net/i2p/router/web/WebAppConfiguration.java | 2 +- .../java/src/net/i2p/router/web/WebAppStarter.java | 8 ++++---- apps/sam/java/src/net/i2p/sam/MasterSession.java | 1 - apps/sam/java/src/net/i2p/sam/SAMv3StreamSession.java | 3 +-- apps/sam/java/src/net/i2p/sam/SSLUtil.java | 2 +- apps/susidns/src/java/src/i2p/susi/dns/AddressBean.java | 2 +- apps/susimail/src/src/i2p/susi/util/Folder.java | 2 +- installer/java/src/net/i2p/installer/FixWinPaths.java | 2 +- 17 files changed, 19 insertions(+), 21 deletions(-) diff --git a/apps/BOB/src/net/i2p/BOB/BOB.java b/apps/BOB/src/net/i2p/BOB/BOB.java index 675ad64624..83bf9767c1 100644 --- a/apps/BOB/src/net/i2p/BOB/BOB.java +++ b/apps/BOB/src/net/i2p/BOB/BOB.java @@ -155,7 +155,6 @@ public class BOB implements Runnable, ClientApp { * * @param mgr may be null * @param args non-null - * @throws Exception on bad args * @since 0.9.10 */ public BOB(I2PAppContext context, ClientAppManager mgr, String[] args) { diff --git a/apps/i2psnark/java/src/org/klomp/snark/BitField.java b/apps/i2psnark/java/src/org/klomp/snark/BitField.java index 7ec4727053..c1c238cec3 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/BitField.java +++ b/apps/i2psnark/java/src/org/klomp/snark/BitField.java @@ -48,7 +48,7 @@ public class BitField * as set by the given byte array. This will make a copy of the array. * Extra bytes will be ignored. * - * @throws ArrayOutOfBoundsException if give byte array is not large + * @throws IndexOutOfBoundsException if give byte array is not large * enough. */ public BitField(byte[] bitfield, int size) diff --git a/apps/i2psnark/java/src/org/klomp/snark/MagnetState.java b/apps/i2psnark/java/src/org/klomp/snark/MagnetState.java index 31b85554c0..145d8224df 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/MagnetState.java +++ b/apps/i2psnark/java/src/org/klomp/snark/MagnetState.java @@ -161,7 +161,7 @@ class MagnetState { /** * @return true if this was the last piece - * @throws NPE, IllegalArgumentException, IOException, ... + * @throws NullPointerException IllegalArgumentException, IOException, ... */ public boolean saveChunk(int chunk, byte[] data, int off, int length) throws Exception { if (!isInitialized) @@ -185,7 +185,7 @@ class MagnetState { /** * @return true if this was the last piece - * @throws NPE, IllegalArgumentException, IOException, ... + * @throws NullPointerException IllegalArgumentException, IOException, ... */ private MetaInfo buildMetaInfo() throws Exception { // top map has nothing in it but the info map (no announce) diff --git a/apps/i2psnark/java/src/org/klomp/snark/bencode/BDecoder.java b/apps/i2psnark/java/src/org/klomp/snark/bencode/BDecoder.java index f7a6e06cb7..4d7162e3df 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/bencode/BDecoder.java +++ b/apps/i2psnark/java/src/org/klomp/snark/bencode/BDecoder.java @@ -102,7 +102,7 @@ public class BDecoder * @return The first BEValue on the stream or null when the stream * has ended. * - * @throws InvalidBEncoding when the stream doesn't start with a + * @throws InvalidBEncodingException when the stream doesn't start with a * bencoded value or the stream isn't a bencoded stream at all. * @throws IOException when somthing bad happens with the stream * to read from. diff --git a/apps/i2psnark/java/src/org/klomp/snark/dht/NodeInfo.java b/apps/i2psnark/java/src/org/klomp/snark/dht/NodeInfo.java index 708d2d2766..35d5761aae 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/dht/NodeInfo.java +++ b/apps/i2psnark/java/src/org/klomp/snark/dht/NodeInfo.java @@ -77,7 +77,7 @@ class NodeInfo extends SimpleDataStructure { * @param compactInfo 20 byte node ID, 32 byte destHash, 2 byte port * @param offset starting at this offset in compactInfo * @throws IllegalArgumentException - * @throws AIOOBE + * @throws ArrayIndexOutOfBoundsException */ public NodeInfo(byte[] compactInfo, int offset) { super(); diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/SSLClientUtil.java b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/SSLClientUtil.java index 01e7c47919..07a3b76653 100644 --- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/SSLClientUtil.java +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/SSLClientUtil.java @@ -153,7 +153,7 @@ public class SSLClientUtil { * Sets up the SSLContext and sets the socket factory. * No option prefix allowed. * - * @throws IOException; GeneralSecurityExceptions are wrapped in IOE for convenience + * @throws IOException GeneralSecurityExceptions are wrapped in IOE for convenience * @return factory, throws on all errors */ public static SSLServerSocketFactory initializeFactory(Properties opts) throws IOException { diff --git a/apps/jetty/java/src/org/mortbay/servlet/MultiPartRequest.java b/apps/jetty/java/src/org/mortbay/servlet/MultiPartRequest.java index ef60acd371..1008e9f301 100644 --- a/apps/jetty/java/src/org/mortbay/servlet/MultiPartRequest.java +++ b/apps/jetty/java/src/org/mortbay/servlet/MultiPartRequest.java @@ -39,7 +39,7 @@ import org.mortbay.util.LineInput; * This class decodes the multipart/form-data stream sent by * a HTML form that uses a file input item. * - *

Usage

+ *

Usage

* Each part of the form data is named from the HTML form and * is available either via getString(name) or getInputStream(name). * Furthermore the MIME parameters and filename can be requested for diff --git a/apps/routerconsole/java/src/net/i2p/router/web/GraphHelper.java b/apps/routerconsole/java/src/net/i2p/router/web/GraphHelper.java index 5beb2ba232..169a795f36 100644 --- a/apps/routerconsole/java/src/net/i2p/router/web/GraphHelper.java +++ b/apps/routerconsole/java/src/net/i2p/router/web/GraphHelper.java @@ -56,7 +56,7 @@ public class GraphHelper extends FormHandler { } /** - * This must be output in the jsp since must be in the + * This must be output in the jsp since *lt;meta> must be in the <head> * @since 0.8.7 */ public String getRefreshMeta() { diff --git a/apps/routerconsole/java/src/net/i2p/router/web/SummaryHelper.java b/apps/routerconsole/java/src/net/i2p/router/web/SummaryHelper.java index 75a55709fa..56cffb2000 100644 --- a/apps/routerconsole/java/src/net/i2p/router/web/SummaryHelper.java +++ b/apps/routerconsole/java/src/net/i2p/router/web/SummaryHelper.java @@ -118,6 +118,7 @@ public class SummaryHelper extends HelperBase { } **/ + /** allowReseed */ public boolean allowReseed() { return _context.netDb().isInitialized() && (_context.netDb().getKnownRouters() < 30) || diff --git a/apps/routerconsole/java/src/net/i2p/router/web/WebAppConfiguration.java b/apps/routerconsole/java/src/net/i2p/router/web/WebAppConfiguration.java index c88ec64d90..3e2eb9ecc6 100644 --- a/apps/routerconsole/java/src/net/i2p/router/web/WebAppConfiguration.java +++ b/apps/routerconsole/java/src/net/i2p/router/web/WebAppConfiguration.java @@ -37,7 +37,7 @@ import org.eclipse.jetty.webapp.WebAppContext; * * No, wac.addClassPath() does not work. For more info see: * - * http://servlets.com/archive/servlet/ReadMsg?msgId=511113&listName=jetty-support + * http://servlets.com/archive/servlet/ReadMsg?msgId=511113&listName=jetty-support * * @since 0.7.12 * @author zzz diff --git a/apps/routerconsole/java/src/net/i2p/router/web/WebAppStarter.java b/apps/routerconsole/java/src/net/i2p/router/web/WebAppStarter.java index 4455945e83..70a86a89b4 100644 --- a/apps/routerconsole/java/src/net/i2p/router/web/WebAppStarter.java +++ b/apps/routerconsole/java/src/net/i2p/router/web/WebAppStarter.java @@ -27,7 +27,7 @@ import org.eclipse.jetty.webapp.WebAppContext; * * No, wac.addClassPath() does not work. For more info see: * - * http://servlets.com/archive/servlet/ReadMsg?msgId=511113&listName=jetty-support + * http://servlets.com/archive/servlet/ReadMsg?msgId=511113&listName=jetty-support * * @since 0.7.12 * @author zzz @@ -51,7 +51,7 @@ public class WebAppStarter { * Adds and starts. * Prior to 0.9.28, was not guaranteed to throw on failure. * - * @throws just about anything, caller would be wise to catch Throwable + * @throws Exception just about anything, caller would be wise to catch Throwable */ static void startWebApp(RouterContext ctx, ContextHandlerCollection server, String appName, String warPath) throws Exception { @@ -123,8 +123,8 @@ public class WebAppStarter { } /** - * stop it and remove the context - * @throws just about anything, caller would be wise to catch Throwable + * Stop it and remove the context. + * Throws just about anything, caller would be wise to catch Throwable */ static void stopWebApp(String appName) { ContextHandler wac = getWebApp(appName); diff --git a/apps/sam/java/src/net/i2p/sam/MasterSession.java b/apps/sam/java/src/net/i2p/sam/MasterSession.java index 67ff566b56..fc69a7238c 100644 --- a/apps/sam/java/src/net/i2p/sam/MasterSession.java +++ b/apps/sam/java/src/net/i2p/sam/MasterSession.java @@ -54,7 +54,6 @@ class MasterSession extends SAMv3StreamSession implements SAMDatagramReceiver, S * @param nick nickname of the session * @throws IOException * @throws DataFormatException - * @throws I2PSessionException */ public MasterSession(String nick, SAMv3DatagramServer dgServer, SAMv3Handler handler, Properties props) throws IOException, DataFormatException, SAMException { diff --git a/apps/sam/java/src/net/i2p/sam/SAMv3StreamSession.java b/apps/sam/java/src/net/i2p/sam/SAMv3StreamSession.java index f547a2e402..8be28b4759 100644 --- a/apps/sam/java/src/net/i2p/sam/SAMv3StreamSession.java +++ b/apps/sam/java/src/net/i2p/sam/SAMv3StreamSession.java @@ -77,7 +77,7 @@ class SAMv3StreamSession extends SAMStreamSession implements Session * @throws IOException * @throws DataFormatException * @throws SAMException - * @throws NPE if login nickname is not registered + * @throws NullPointerException if login nickname is not registered */ public SAMv3StreamSession(String login) throws IOException, DataFormatException, SAMException @@ -98,7 +98,6 @@ class SAMv3StreamSession extends SAMStreamSession implements Session * @param login nickname of the session * @throws IOException * @throws DataFormatException - * @throws I2PSessionException * @since 0.9.25 */ public SAMv3StreamSession(String login, Properties props, SAMv3Handler handler, I2PSocketManager mgr, diff --git a/apps/sam/java/src/net/i2p/sam/SSLUtil.java b/apps/sam/java/src/net/i2p/sam/SSLUtil.java index bf4ebf1e42..cf170f6ecf 100644 --- a/apps/sam/java/src/net/i2p/sam/SSLUtil.java +++ b/apps/sam/java/src/net/i2p/sam/SSLUtil.java @@ -138,7 +138,7 @@ class SSLUtil { * Sets up the SSLContext and sets the socket factory. * No option prefix allowed. * - * @throws IOException; GeneralSecurityExceptions are wrapped in IOE for convenience + * @throws IOException GeneralSecurityExceptions are wrapped in IOE for convenience * @return factory, throws on all errors */ public static SSLServerSocketFactory initializeFactory(Properties opts) throws IOException { diff --git a/apps/susidns/src/java/src/i2p/susi/dns/AddressBean.java b/apps/susidns/src/java/src/i2p/susi/dns/AddressBean.java index 242ceea85e..d988d40afb 100644 --- a/apps/susidns/src/java/src/i2p/susi/dns/AddressBean.java +++ b/apps/susidns/src/java/src/i2p/susi/dns/AddressBean.java @@ -110,7 +110,7 @@ public class AddressBean * Ref: java.net.IDN and RFC 3940 * @param host will be converted to lower case * @return name converted to lower case and punycoded if necessary - * @throws IAE on various errors or if IDN is needed but not available + * @throws IllegalArgumentException on various errors or if IDN is needed but not available * @since 0.8.7 */ static String toASCII(String host) throws IllegalArgumentException { diff --git a/apps/susimail/src/src/i2p/susi/util/Folder.java b/apps/susimail/src/src/i2p/susi/util/Folder.java index 54f647d87a..d2a44a6cd1 100644 --- a/apps/susimail/src/src/i2p/susi/util/Folder.java +++ b/apps/susimail/src/src/i2p/susi/util/Folder.java @@ -369,7 +369,7 @@ public class Folder { * Sets the sorting direction of the folder. * Does not re-sort. Caller must call sortBy() * - * @param direction @link UP or @link DOWN + * @param direction UP or DOWN */ public synchronized void setSortingDirection(SortOrder direction) { diff --git a/installer/java/src/net/i2p/installer/FixWinPaths.java b/installer/java/src/net/i2p/installer/FixWinPaths.java index 698f6102cf..605c872c6b 100644 --- a/installer/java/src/net/i2p/installer/FixWinPaths.java +++ b/installer/java/src/net/i2p/installer/FixWinPaths.java @@ -17,7 +17,7 @@ import java.io.PrintStream; *
  • rewrites the applicable wrapper config options to point to %APPDATA%\I2P
    • *
  • corrects the paths, rewriting / to \
    • * - *

    + *

    * Usage: FixWinPaths [WrapperConfigFile] * @since 0.9.5 */