From 112fa503e63506fbfcefd785628be2bd1f618c84 Mon Sep 17 00:00:00 2001 From: zzz Date: Fri, 27 Jan 2017 03:03:34 +0000 Subject: [PATCH] javadoc fixes part 13 (ticket #1894) --- apps/BOB/src/net/i2p/BOB/I2PtoTCP.java | 2 +- apps/BOB/src/net/i2p/BOB/TCPtoI2P.java | 2 +- .../java/src/org/klomp/snark/I2PSnarkUtil.java | 8 ++++---- .../java/src/org/klomp/snark/PeerCoordinator.java | 4 ++-- .../java/src/org/klomp/snark/SnarkManager.java | 6 +++--- .../i2psnark/java/src/org/klomp/snark/Storage.java | 2 +- .../i2psnark/java/src/org/klomp/snark/dht/DHT.java | 4 ++-- .../java/src/org/klomp/snark/dht/KRPC.java | 14 +++++++------- .../java/src/org/klomp/snark/web/URIUtil.java | 2 +- apps/susimail/src/src/i2p/susi/webmail/Mail.java | 4 ++-- 10 files changed, 24 insertions(+), 24 deletions(-) diff --git a/apps/BOB/src/net/i2p/BOB/I2PtoTCP.java b/apps/BOB/src/net/i2p/BOB/I2PtoTCP.java index a7ec29ab3..3e474704f 100644 --- a/apps/BOB/src/net/i2p/BOB/I2PtoTCP.java +++ b/apps/BOB/src/net/i2p/BOB/I2PtoTCP.java @@ -25,7 +25,7 @@ import net.i2p.data.DataHelper; import net.i2p.util.I2PAppThread; /** - * Process I2P->TCP + * Process I2P->TCP * * @author sponge */ diff --git a/apps/BOB/src/net/i2p/BOB/TCPtoI2P.java b/apps/BOB/src/net/i2p/BOB/TCPtoI2P.java index cee1f78b6..841c850a0 100644 --- a/apps/BOB/src/net/i2p/BOB/TCPtoI2P.java +++ b/apps/BOB/src/net/i2p/BOB/TCPtoI2P.java @@ -35,7 +35,7 @@ import net.i2p.util.I2PAppThread; /** * - * Process TCP->I2P + * Process TCP->I2P * * @author sponge */ diff --git a/apps/i2psnark/java/src/org/klomp/snark/I2PSnarkUtil.java b/apps/i2psnark/java/src/org/klomp/snark/I2PSnarkUtil.java index 1bff1a74b..58f27742b 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/I2PSnarkUtil.java +++ b/apps/i2psnark/java/src/org/klomp/snark/I2PSnarkUtil.java @@ -357,12 +357,12 @@ public class I2PSnarkUtil { public File get(String url, boolean rewrite) { return get(url, rewrite, 0); } /** - * @param retries if < 0, set timeout to a few seconds + * @param retries if < 0, set timeout to a few seconds */ public File get(String url, int retries) { return get(url, true, retries); } /** - * @param retries if < 0, set timeout to a few seconds + * @param retries if < 0, set timeout to a few seconds */ public File get(String url, boolean rewrite, int retries) { if (_log.shouldLog(Log.DEBUG)) @@ -413,7 +413,7 @@ public class I2PSnarkUtil { /** * Fetch to memory - * @param retries if < 0, set timeout to a few seconds + * @param retries if < 0, set timeout to a few seconds * @param initialSize buffer size * @param maxSize fails if greater * @return null on error @@ -659,7 +659,7 @@ public class I2PSnarkUtil { * * @param s string to be translated containing {0} * The {0} will be replaced by the parameter. - * Single quotes must be doubled, i.e. ' -> '' in the string. + * Single quotes must be doubled, i.e. ' -> '' in the string. * @param o parameter, not translated. * To translate parameter also, use _t("foo {0} bar", _t("baz")) * Do not double the single quotes in the parameter. diff --git a/apps/i2psnark/java/src/org/klomp/snark/PeerCoordinator.java b/apps/i2psnark/java/src/org/klomp/snark/PeerCoordinator.java index 9e4df703c..415ee0d1a 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/PeerCoordinator.java +++ b/apps/i2psnark/java/src/org/klomp/snark/PeerCoordinator.java @@ -385,7 +385,7 @@ class PeerCoordinator implements PeerListener /** * Inbound. - * Not halted, peers < max. + * Not halted, peers < max. * @since 0.9.1 */ public boolean needPeers() @@ -395,7 +395,7 @@ class PeerCoordinator implements PeerListener /** * Outbound. - * Not halted, peers < max, and need pieces. + * Not halted, peers < max, and need pieces. * @since 0.9.1 */ public boolean needOutboundPeers() { diff --git a/apps/i2psnark/java/src/org/klomp/snark/SnarkManager.java b/apps/i2psnark/java/src/org/klomp/snark/SnarkManager.java index 98be94d73..fde46724b 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/SnarkManager.java +++ b/apps/i2psnark/java/src/org/klomp/snark/SnarkManager.java @@ -324,7 +324,7 @@ public class SnarkManager implements CompleteListener { /** * Use if it does not include a link. - * Escapes '<' and '>' before queueing + * Escapes '<' and '>' before queueing */ public void addMessage(String message) { addMessageNoEscape(message.replace("<", "<").replace(">", ">")); @@ -332,7 +332,7 @@ public class SnarkManager implements CompleteListener { /** * Use if it includes a link. - * Does not escape '<' and '>' before queueing + * Does not escape '<' and '>' before queueing * @since 0.9.14.1 */ public void addMessageNoEscape(String message) { @@ -2558,7 +2558,7 @@ public class SnarkManager implements CompleteListener { /** * Stop all running torrents, and close the tunnel after a delay * to allow for announces. - * If called at router shutdown via Jetty shutdown hook -> webapp destroy() -> stop(), + * If called at router shutdown via Jetty shutdown hook -> webapp destroy() -> stop(), * the tunnel won't actually be closed as the SimpleTimer2 is already shutdown * or will be soon, so we delay a few seconds inline. * @param finalShutdown if true, sleep at the end if any torrents were running diff --git a/apps/i2psnark/java/src/org/klomp/snark/Storage.java b/apps/i2psnark/java/src/org/klomp/snark/Storage.java index 4db3b5896..c451d3baa 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/Storage.java +++ b/apps/i2psnark/java/src/org/klomp/snark/Storage.java @@ -436,7 +436,7 @@ public class Storage implements Closeable * Must call Snark.updatePiecePriorities() * (which calls getPiecePriorities()) after calling this. * @param fileIndex as obtained from indexOf - * @param pri default 0; <0 to disable + * @param pri default 0; <0 to disable * @since 0.8.1 */ public void setPriority(int fileIndex, int pri) { diff --git a/apps/i2psnark/java/src/org/klomp/snark/dht/DHT.java b/apps/i2psnark/java/src/org/klomp/snark/dht/DHT.java index d4f289791..2614486bb 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/dht/DHT.java +++ b/apps/i2psnark/java/src/org/klomp/snark/dht/DHT.java @@ -42,7 +42,7 @@ public interface DHT { * * @param ih the Info Hash (torrent) * @param max maximum number of peers to return - * @param maxWait the maximum time to wait (ms) must be > 0 + * @param maxWait the maximum time to wait (ms) must be > 0 * @param annMax the number of peers to announce to * @param annMaxWait the maximum total time to wait for announces, may be 0 to return immediately without waiting for acks * @param isSeed true if seed, false if leech @@ -81,7 +81,7 @@ public interface DHT { /** * Announce to the closest DHT peers. - * Blocking unless maxWait <= 0 + * Blocking unless maxWait <= 0 * Caller should run in a thread. * This also automatically announces ourself to our local tracker. * For best results do a getPeers() first so we have tokens. diff --git a/apps/i2psnark/java/src/org/klomp/snark/dht/KRPC.java b/apps/i2psnark/java/src/org/klomp/snark/dht/KRPC.java index f92c3da99..1ebf97510 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/dht/KRPC.java +++ b/apps/i2psnark/java/src/org/klomp/snark/dht/KRPC.java @@ -245,7 +245,7 @@ public class KRPC implements I2PSessionMuxedListener, DHT { * * @param target the key we are searching for * @param maxNodes how many to contact - * @param maxWait how long to wait for each to reply (not total) must be > 0 + * @param maxWait how long to wait for each to reply (not total) must be > 0 * @param parallel how many outstanding at once (unimplemented, always 1) */ @SuppressWarnings("unchecked") @@ -326,7 +326,7 @@ public class KRPC implements I2PSessionMuxedListener, DHT { * * @param ih the Info Hash (torrent) * @param max maximum number of peers to return - * @param maxWait the maximum time to wait (ms) must be > 0 + * @param maxWait the maximum time to wait (ms) must be > 0 * @param annMax the number of peers to announce to * @param annMaxWait the maximum total time to wait for announces, may be 0 to return immediately without waiting for acks * @param isSeed true if seed, false if leech @@ -510,7 +510,7 @@ public class KRPC implements I2PSessionMuxedListener, DHT { * Announce to the closest peers in the local DHT. * This is NOT iterative - call getPeers() first to get the closest * peers into the local DHT. - * Blocking unless maxWait <= 0 + * Blocking unless maxWait <= 0 * Caller should run in a thread. * This also automatically announces ourself to our local tracker. * For best results do a getPeersAndAnnounce() instead, as this announces to @@ -544,7 +544,7 @@ public class KRPC implements I2PSessionMuxedListener, DHT { /** * Announce to a single DHT peer. - * Blocking unless maxWait <= 0 + * Blocking unless maxWait <= 0 * Caller should run in a thread. * For best results do a getPeers() first so we have a token. * @@ -1509,9 +1509,9 @@ public class KRPC implements I2PSessionMuxedListener, DHT { /** * Should contain null if getReplyCode is REPLY_PONG. - * Should contain List if getReplyCode is REPLY_PEERS. - * Should contain List if getReplyCode is REPLY_NODES. - * Should contain String if getReplyCode is > 200. + * Should contain List<Hash> if getReplyCode is REPLY_PEERS. + * Should contain List<NodeInfo> if getReplyCode is REPLY_NODES. + * Should contain String if getReplyCode is > 200. * @return may be null depending on what happened. Cast to expected type. */ public Object getReplyObject() { diff --git a/apps/i2psnark/java/src/org/klomp/snark/web/URIUtil.java b/apps/i2psnark/java/src/org/klomp/snark/web/URIUtil.java index 858b9aec8..532db2956 100644 --- a/apps/i2psnark/java/src/org/klomp/snark/web/URIUtil.java +++ b/apps/i2psnark/java/src/org/klomp/snark/web/URIUtil.java @@ -57,7 +57,7 @@ class URIUtil /** Encode a URI path. * - * Somewhat oddly, this encodes all chars >= 0x80 if buf is null, (strict RFC 2396) + * Somewhat oddly, this encodes all chars >= 0x80 if buf is null, (strict RFC 2396) * but only the control, space, and special chars if buf is non-null. * * @param path The path the encode diff --git a/apps/susimail/src/src/i2p/susi/webmail/Mail.java b/apps/susimail/src/src/i2p/susi/webmail/Mail.java index e43fe3b8a..726dab5a8 100644 --- a/apps/susimail/src/src/i2p/susi/webmail/Mail.java +++ b/apps/susimail/src/src/i2p/susi/webmail/Mail.java @@ -3,7 +3,7 @@ * * This file is part of susimail project, see http://susi.i2p/ * - * Copyright (C) 2004-2005 + * Copyright (C) 2004-2005 susi23@mail.i2p * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -204,7 +204,7 @@ class Mail { } /** - * Returns the first email address portion, enclosed by <> + * Returns the first email address portion, enclosed by <> * @param address */ public static String getAddress(String address )