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

javadoc fixes part 14 (ticket #1894)

Browse Source
This commit is contained in:
zzz
2017-01-27 03:14:34 +00:00
parent 112fa503e6
commit e0e06d73eb
17 changed files with 19 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
apps/BOB/src/net/i2p/BOB/BOB.java
View File

@ -155,7 +155,6 @@ public class BOB implements Runnable, ClientApp {
* *
* @param mgr may be null * @param mgr may be null
* @param args non-null * @param args non-null
* @throws Exception on bad args
* @since 0.9.10 * @since 0.9.10
*/ */
public BOB(I2PAppContext context, ClientAppManager mgr, String[] args) { public BOB(I2PAppContext context, ClientAppManager mgr, String[] args) {

2
apps/i2psnark/java/src/org/klomp/snark/BitField.java
View File

@ -48,7 +48,7 @@ public class BitField
* as set by the given byte array. This will make a copy of the array. * as set by the given byte array. This will make a copy of the array.
* Extra bytes will be ignored. * Extra bytes will be ignored.
* *
* @throws ArrayOutOfBoundsException if give byte array is not large * @throws IndexOutOfBoundsException if give byte array is not large
* enough. * enough.
*/ */
public BitField(byte[] bitfield, int size) public BitField(byte[] bitfield, int size)

4
apps/i2psnark/java/src/org/klomp/snark/MagnetState.java
View File

@ -161,7 +161,7 @@ class MagnetState {
/** /**
* @return true if this was the last piece * @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 { public boolean saveChunk(int chunk, byte[] data, int off, int length) throws Exception {
if (!isInitialized) if (!isInitialized)
@ -185,7 +185,7 @@ class MagnetState {
/** /**
* @return true if this was the last piece * @return true if this was the last piece
* @throws NPE, IllegalArgumentException, IOException, ... * @throws NullPointerException IllegalArgumentException, IOException, ...
*/ */
private MetaInfo buildMetaInfo() throws Exception { private MetaInfo buildMetaInfo() throws Exception {
// top map has nothing in it but the info map (no announce) // top map has nothing in it but the info map (no announce)

2
apps/i2psnark/java/src/org/klomp/snark/bencode/BDecoder.java
View File

@ -102,7 +102,7 @@ public class BDecoder
* @return The first BEValue on the stream or null when the stream * @return The first BEValue on the stream or null when the stream
* has ended. * 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. * bencoded value or the stream isn't a bencoded stream at all.
* @throws IOException when somthing bad happens with the stream * @throws IOException when somthing bad happens with the stream
* to read from. * to read from.

2
apps/i2psnark/java/src/org/klomp/snark/dht/NodeInfo.java
View File

@ -77,7 +77,7 @@ class NodeInfo extends SimpleDataStructure {
* @param compactInfo 20 byte node ID, 32 byte destHash, 2 byte port * @param compactInfo 20 byte node ID, 32 byte destHash, 2 byte port
* @param offset starting at this offset in compactInfo * @param offset starting at this offset in compactInfo
* @throws IllegalArgumentException * @throws IllegalArgumentException
* @throws AIOOBE * @throws ArrayIndexOutOfBoundsException
*/ */
public NodeInfo(byte[] compactInfo, int offset) { public NodeInfo(byte[] compactInfo, int offset) {
super(); super();

2
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/SSLClientUtil.java
View File

@ -153,7 +153,7 @@ public class SSLClientUtil {
* Sets up the SSLContext and sets the socket factory. * Sets up the SSLContext and sets the socket factory.
* No option prefix allowed. * 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 * @return factory, throws on all errors
*/ */
public static SSLServerSocketFactory initializeFactory(Properties opts) throws IOException { public static SSLServerSocketFactory initializeFactory(Properties opts) throws IOException {

2
apps/jetty/java/src/org/mortbay/servlet/MultiPartRequest.java
View File

@ -39,7 +39,7 @@ import org.mortbay.util.LineInput;
* This class decodes the multipart/form-data stream sent by * This class decodes the multipart/form-data stream sent by
* a HTML form that uses a file input item. * a HTML form that uses a file input item.
* *
* <p><h4>Usage</h4> * <h4>Usage</h4>
* Each part of the form data is named from the HTML form and * Each part of the form data is named from the HTML form and
* is available either via getString(name) or getInputStream(name). * is available either via getString(name) or getInputStream(name).
* Furthermore the MIME parameters and filename can be requested for * Furthermore the MIME parameters and filename can be requested for

2
apps/routerconsole/java/src/net/i2p/router/web/GraphHelper.java
View File

@ -56,7 +56,7 @@ public class GraphHelper extends FormHandler {
} }
/** /**
* This must be output in the jsp since <meta> must be in the <head> * This must be output in the jsp since *lt;meta&gt; must be in the &lt;head&gt;
* @since 0.8.7 * @since 0.8.7
*/ */
public String getRefreshMeta() { public String getRefreshMeta() {

1
apps/routerconsole/java/src/net/i2p/router/web/SummaryHelper.java
View File

@ -118,6 +118,7 @@ public class SummaryHelper extends HelperBase {
} }
**/ **/
/** allowReseed */
public boolean allowReseed() { public boolean allowReseed() {
return _context.netDb().isInitialized() && return _context.netDb().isInitialized() &&
(_context.netDb().getKnownRouters() < 30) || (_context.netDb().getKnownRouters() < 30) ||

2
apps/routerconsole/java/src/net/i2p/router/web/WebAppConfiguration.java
View File

@ -37,7 +37,7 @@ import org.eclipse.jetty.webapp.WebAppContext;
* *
* No, wac.addClassPath() does not work. For more info see: * 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&amp;listName=jetty-support
* *
* @since 0.7.12 * @since 0.7.12
* @author zzz * @author zzz

8
apps/routerconsole/java/src/net/i2p/router/web/WebAppStarter.java
View File

@ -27,7 +27,7 @@ import org.eclipse.jetty.webapp.WebAppContext;
* *
* No, wac.addClassPath() does not work. For more info see: * 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&amp;listName=jetty-support
* *
* @since 0.7.12 * @since 0.7.12
* @author zzz * @author zzz
@ -51,7 +51,7 @@ public class WebAppStarter {
* Adds and starts. * Adds and starts.
* Prior to 0.9.28, was not guaranteed to throw on failure. * 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, static void startWebApp(RouterContext ctx, ContextHandlerCollection server,
String appName, String warPath) throws Exception { String appName, String warPath) throws Exception {
@ -123,8 +123,8 @@ public class WebAppStarter {
} }
/** /**
* stop it and remove the context * Stop it and remove the context.
* @throws just about anything, caller would be wise to catch Throwable * Throws just about anything, caller would be wise to catch Throwable
*/ */
static void stopWebApp(String appName) { static void stopWebApp(String appName) {
ContextHandler wac = getWebApp(appName); ContextHandler wac = getWebApp(appName);

1
apps/sam/java/src/net/i2p/sam/MasterSession.java
View File

@ -54,7 +54,6 @@ class MasterSession extends SAMv3StreamSession implements SAMDatagramReceiver, S
* @param nick nickname of the session * @param nick nickname of the session
* @throws IOException * @throws IOException
* @throws DataFormatException * @throws DataFormatException
* @throws I2PSessionException
*/ */
public MasterSession(String nick, SAMv3DatagramServer dgServer, SAMv3Handler handler, Properties props) public MasterSession(String nick, SAMv3DatagramServer dgServer, SAMv3Handler handler, Properties props)
throws IOException, DataFormatException, SAMException { throws IOException, DataFormatException, SAMException {

3
apps/sam/java/src/net/i2p/sam/SAMv3StreamSession.java
View File

@ -77,7 +77,7 @@ class SAMv3StreamSession extends SAMStreamSession implements Session
* @throws IOException * @throws IOException
* @throws DataFormatException * @throws DataFormatException
* @throws SAMException * @throws SAMException
* @throws NPE if login nickname is not registered * @throws NullPointerException if login nickname is not registered
*/ */
public SAMv3StreamSession(String login) public SAMv3StreamSession(String login)
throws IOException, DataFormatException, SAMException throws IOException, DataFormatException, SAMException
@ -98,7 +98,6 @@ class SAMv3StreamSession extends SAMStreamSession implements Session
* @param login nickname of the session * @param login nickname of the session
* @throws IOException * @throws IOException
* @throws DataFormatException * @throws DataFormatException
* @throws I2PSessionException
* @since 0.9.25 * @since 0.9.25
*/ */
public SAMv3StreamSession(String login, Properties props, SAMv3Handler handler, I2PSocketManager mgr, public SAMv3StreamSession(String login, Properties props, SAMv3Handler handler, I2PSocketManager mgr,

2
apps/sam/java/src/net/i2p/sam/SSLUtil.java
View File

@ -138,7 +138,7 @@ class SSLUtil {
* Sets up the SSLContext and sets the socket factory. * Sets up the SSLContext and sets the socket factory.
* No option prefix allowed. * 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 * @return factory, throws on all errors
*/ */
public static SSLServerSocketFactory initializeFactory(Properties opts) throws IOException { public static SSLServerSocketFactory initializeFactory(Properties opts) throws IOException {

2
apps/susidns/src/java/src/i2p/susi/dns/AddressBean.java
View File

@ -110,7 +110,7 @@ public class AddressBean
* Ref: java.net.IDN and RFC 3940 * Ref: java.net.IDN and RFC 3940
* @param host will be converted to lower case * @param host will be converted to lower case
* @return name converted to lower case and punycoded if necessary * @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 * @since 0.8.7
*/ */
static String toASCII(String host) throws IllegalArgumentException { static String toASCII(String host) throws IllegalArgumentException {

2
apps/susimail/src/src/i2p/susi/util/Folder.java
View File

@ -369,7 +369,7 @@ public class Folder<O extends Object> {
* Sets the sorting direction of the folder. * Sets the sorting direction of the folder.
* Does not re-sort. Caller must call sortBy() * 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) public synchronized void setSortingDirection(SortOrder direction)
{ {

2
installer/java/src/net/i2p/installer/FixWinPaths.java
View File

@ -17,7 +17,7 @@ import java.io.PrintStream;
* <li>rewrites the applicable wrapper config options to point to <code>%APPDATA%\I2P</code></li> * <li>rewrites the applicable wrapper config options to point to <code>%APPDATA%\I2P</code></li>
* <li>corrects the paths, rewriting <code>/</code> to <code>\</code></li> * <li>corrects the paths, rewriting <code>/</code> to <code>\</code></li>
* </ul> * </ul>
* </p> * <p>
* Usage: <code>FixWinPaths [WrapperConfigFile]</code> * Usage: <code>FixWinPaths [WrapperConfigFile]</code>
* @since 0.9.5 * @since 0.9.5
*/ */