From 9dab3b0dfe3bedd04a42b29ece91f66452634a7d Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Fri, 27 Jan 2017 02:27:53 +0000
Subject: [PATCH] javadoc fixes part 12 (ticket #1894)
---
.../java/src/net/i2p/i2ptunnel/I2PTunnel.java | 12 ++++++------
.../src/net/i2p/i2ptunnel/I2PTunnelClientBase.java | 10 +++++-----
.../java/src/net/i2p/i2ptunnel/ui/TunnelConfig.java | 4 ++--
.../java/src/net/i2p/router/web/PluginStarter.java | 6 +++---
.../client/streaming/impl/SchedulerPreconnect.java | 1 +
.../router/transport/udp/InboundEstablishState.java | 2 +-
.../src/net/i2p/router/tunnel/FragmentedMessage.java | 1 +
.../src/net/i2p/router/tunnel/TunnelParticipant.java | 1 +
.../i2p/router/util/CoDelPriorityBlockingQueue.java | 2 +-
.../src/net/i2p/router/util/DecayingBloomFilter.java | 2 +-
.../src/org/freenetproject/ForwardPortStatus.java | 2 +-
11 files changed, 23 insertions(+), 20 deletions(-)
diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnel.java b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnel.java
index 4b61312bbd..74ae307d35 100644
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnel.java
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnel.java
@@ -559,7 +559,7 @@ public class I2PTunnel extends EventDispatcherImpl implements Logging {
/**
* Run the server pointing at the host and port specified using the private i2p
- * destination loaded from the specified file. <p />
+ * destination loaded from the specified file. <p>
*
* Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
* Also sets the event "openServerResult" = "ok" or "error" (displaying "Ready!" on the logger after
@@ -669,7 +669,7 @@ public class I2PTunnel extends EventDispatcherImpl implements Logging {
/**
* Run the HTTP server pointing at the host and port specified using the private i2p
* destination loaded from the specified file, replacing the HTTP headers
- * so that the Host: specified is the one spoofed. <p />
+ * so that the Host: specified is the one spoofed. <p>
*
* Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
* Also sets the event "openServerResult" = "ok" or "error" (displaying "Ready!" on the logger after
@@ -733,7 +733,7 @@ public class I2PTunnel extends EventDispatcherImpl implements Logging {
* Run the HTTP server pointing at the host and port specified using the private i2p
* destination loaded from the specified file, replacing the HTTP headers
* so that the Host: specified is the one spoofed. Also runs an HTTP proxy for
- * bidirectional communications on the same tunnel destination.<p />
+ * bidirectional communications on the same tunnel destination.<p>
*
* Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
* Also sets the event "openServerResult" = "ok" or "error" (displaying "Ready!" on the logger after
@@ -808,7 +808,7 @@ public class I2PTunnel extends EventDispatcherImpl implements Logging {
/**
* Run the server pointing at the host and port specified using the private i2p
- * destination loaded from the given base64 stream. <p />
+ * destination loaded from the given base64 stream. <p>
*
* Deprecated? Why run a server with a private destination?
* Not available from the war GUI
@@ -1821,12 +1821,12 @@ public class I2PTunnel extends EventDispatcherImpl implements Logging {
/**
* Generates a Destination from a name. Now only supports base64
- * names - may support naming servers later. "file:<filename>" is
+ * names - may support naming servers later. "file:<filename>" is
* also supported, where filename is a file that either contains a
* binary Destination structure or the Base64 encoding of that
* structure.
*
- * Since file:<filename> isn't really used, this method is deprecated,
+ * Since file:<filename> isn't really used, this method is deprecated,
* just call context.namingService.lookup() directly.
* @deprecated Don't use i2ptunnel for lookup! Use I2PAppContext.getGlobalContext().namingService().lookup(name) from i2p.jar
*/
diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnelClientBase.java b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnelClientBase.java
index 268da43225..a3c9f85660 100644
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnelClientBase.java
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnelClientBase.java
@@ -93,7 +93,7 @@ public abstract class I2PTunnelClientBase extends I2PTunnelTask implements Runna
/**
* This constructor is used to add a client to an existing socket manager.
- * <p/>
+ * <p>
* As of 0.9.21 this does NOT open the local socket. You MUST call
* {@link #startRunning()} for that. The local socket will be opened
* immediately (ignoring the <code>i2cp.delayOpen</code> option).
@@ -119,10 +119,10 @@ public abstract class I2PTunnelClientBase extends I2PTunnelTask implements Runna
/**
* The main constructor.
- * <p/>
+ * <p>
* As of 0.9.21 this is fast, and does NOT connect the manager to the router,
* or open the local socket. You MUST call startRunning() for that.
- * <p/>
+ * <p>
* (0.9.20 claimed to be fast, but due to a bug it DID connect the manager
* to the router. It did NOT open the local socket however, so it was still
* necessary to call startRunning() for that.)
@@ -139,10 +139,10 @@ public abstract class I2PTunnelClientBase extends I2PTunnelTask implements Runna
/**
* Use this to build a client with a persistent private key.
- * <p/>
+ * <p>
* As of 0.9.21 this is fast, and does NOT connect the manager to the router,
* or open the local socket. You MUST call startRunning() for that.
- * <p/>
+ * <p>
* (0.9.20 claimed to be fast, but due to a bug it DID connect the manager
* to the router. It did NOT open the local socket however, so it was still
* necessary to call startRunning() for that.)
diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/TunnelConfig.java b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/TunnelConfig.java
index a030255c90..0a007e3783 100644
--- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/TunnelConfig.java
+++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/ui/TunnelConfig.java
@@ -249,7 +249,7 @@ public class TunnelConfig {
/**
* Controls how other tunnels are checked for access.
- * <p/>
+ * <p>
* The list used for whitelisting/blacklisting can be set with
* {@link #setAccessList(String)}.
*
@@ -280,7 +280,7 @@ public class TunnelConfig {
/**
* Controls how ephemeral the I2P Destination of a client tunnel is.
- * <p/>
+ * <p>
* If {@link #setClose(boolean)} is set to false then mode 1 == mode 0.
*
* @param mode 0 for new dest on restart, 1 for new dest on resume from idle, 2 for persistent key
diff --git a/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java b/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java
index cc749e0d7d..9c9c7e9ddc 100644
--- a/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java
+++ b/apps/routerconsole/java/src/net/i2p/router/web/PluginStarter.java
@@ -263,7 +263,7 @@ public class PluginStarter implements Runnable {
/**
* @return true on success
- * @throws just about anything, caller would be wise to catch Throwable
+ * @throws Exception just about anything, caller would be wise to catch Throwable
*/
@SuppressWarnings("deprecation")
public static boolean startPlugin(RouterContext ctx, String appName) throws Exception {
@@ -466,7 +466,7 @@ public class PluginStarter implements Runnable {
/**
* @return true on success
- * @throws just about anything, caller would be wise to catch Throwable
+ * @throws Exception just about anything, caller would be wise to catch Throwable
*/
public static boolean stopPlugin(RouterContext ctx, String appName) throws Exception {
Log log = ctx.logManager().getLog(PluginStarter.class);
@@ -702,7 +702,7 @@ public class PluginStarter implements Runnable {
/**
* @param action "start" or "stop" or "uninstall"
- * @throws just about anything if an app has a delay less than zero, caller would be wise to catch Throwable
+ * @throws Exception just about anything if an app has a delay less than zero, caller would be wise to catch Throwable
* If no apps have a delay less than zero, it shouldn't throw anything
*/
private static void runClientApps(RouterContext ctx, File pluginDir, List<ClientAppConfig> apps, String action) throws Exception {
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/impl/SchedulerPreconnect.java b/apps/streaming/java/src/net/i2p/client/streaming/impl/SchedulerPreconnect.java
index abf08d451b..7464341fc5 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/impl/SchedulerPreconnect.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/impl/SchedulerPreconnect.java
@@ -20,6 +20,7 @@ import net.i2p.util.Log;
* </ul>
*
* <h2>Next states:</h2>
+ * <ul>
* <li>{@link SchedulerConnecting connecting} - after sending a packet</li>
* </ul>
*/
diff --git a/router/java/src/net/i2p/router/transport/udp/InboundEstablishState.java b/router/java/src/net/i2p/router/transport/udp/InboundEstablishState.java
index 332282c24d..509d749429 100644
--- a/router/java/src/net/i2p/router/transport/udp/InboundEstablishState.java
+++ b/router/java/src/net/i2p/router/transport/udp/InboundEstablishState.java
@@ -94,7 +94,7 @@ class InboundEstablishState {
/**
* @param localPort Must be our external port, otherwise the signature of the
- & SessionCreated message will be bad if the external port != the internal port.
+ * SessionCreated message will be bad if the external port != the internal port.
*/
public InboundEstablishState(RouterContext ctx, byte remoteIP[], int remotePort, int localPort,
DHSessionKeyBuilder dh) {
diff --git a/router/java/src/net/i2p/router/tunnel/FragmentedMessage.java b/router/java/src/net/i2p/router/tunnel/FragmentedMessage.java
index effc2a4c63..d3ff6e00df 100644
--- a/router/java/src/net/i2p/router/tunnel/FragmentedMessage.java
+++ b/router/java/src/net/i2p/router/tunnel/FragmentedMessage.java
@@ -279,6 +279,7 @@ class FragmentedMessage {
}
****/
+ /** toString */
@Override
public String toString() {
StringBuilder buf = new StringBuilder(128);
diff --git a/router/java/src/net/i2p/router/tunnel/TunnelParticipant.java b/router/java/src/net/i2p/router/tunnel/TunnelParticipant.java
index d580602793..a1ca5bc9d2 100644
--- a/router/java/src/net/i2p/router/tunnel/TunnelParticipant.java
+++ b/router/java/src/net/i2p/router/tunnel/TunnelParticipant.java
@@ -158,6 +158,7 @@ class TunnelParticipant {
}
****/
+ /** getCompleteCount */
public int getCompleteCount() {
if (_handler != null)
return _handler.getCompleteCount();
diff --git a/router/java/src/net/i2p/router/util/CoDelPriorityBlockingQueue.java b/router/java/src/net/i2p/router/util/CoDelPriorityBlockingQueue.java
index fdda06f520..e84ec651ee 100644
--- a/router/java/src/net/i2p/router/util/CoDelPriorityBlockingQueue.java
+++ b/router/java/src/net/i2p/router/util/CoDelPriorityBlockingQueue.java
@@ -69,7 +69,7 @@ public class CoDelPriorityBlockingQueue<E extends CDPQEntry> extends PriBlocking
private final String STAT_DELAY;
public static final int MIN_PRIORITY = 100;
private static final int[] PRIORITIES = {MIN_PRIORITY, 200, 300, 400, 500};
- /** if priority is >= this, never drop */
+ /** if priority is >= this, never drop */
public static final int DONT_DROP_PRIORITY = 1000;
private static final long BACKLOG_TIME = 2*1000;
diff --git a/router/java/src/net/i2p/router/util/DecayingBloomFilter.java b/router/java/src/net/i2p/router/util/DecayingBloomFilter.java
index a47b5ef60e..0afe7450df 100644
--- a/router/java/src/net/i2p/router/util/DecayingBloomFilter.java
+++ b/router/java/src/net/i2p/router/util/DecayingBloomFilter.java
@@ -21,7 +21,7 @@ import org.xlattice.crypto.filters.BloomSHA1;
* See main() for an analysis of false positive rate.
* See BloomFilterIVValidator for instantiation parameters.
* See DecayingHashSet for a smaller and simpler version.
- * @see net.i2p.router.tunnel.BloomFilterIVValidator
+ * See net.i2p.router.tunnel.BloomFilterIVValidator
* @see net.i2p.router.util.DecayingHashSet
*/
public class DecayingBloomFilter {
diff --git a/router/java/src/org/freenetproject/ForwardPortStatus.java b/router/java/src/org/freenetproject/ForwardPortStatus.java
index 88090da403..976881a94f 100644
--- a/router/java/src/org/freenetproject/ForwardPortStatus.java
+++ b/router/java/src/org/freenetproject/ForwardPortStatus.java
@@ -9,7 +9,7 @@ public class ForwardPortStatus {
* for example hostile action on the part of the router. */
public static final int PROBABLE_SUCCESS = 2;
/** The port forward may have succeeded. Or it may not have. We should
- * definitely try to check out of band. See UP&P: Many routers say they've
+ * definitely try to check out of band. See UP&P: Many routers say they've
* forwarded the port when they haven't. */
public static final int MAYBE_SUCCESS = 1;
/** The port forward is in progress */
--
GitLab