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 13 (ticket #1894)

Browse Source
This commit is contained in:
zzz
2017-01-27 03:03:34 +00:00
parent 9dab3b0dfe
commit 112fa503e6
10 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apps/i2psnark/java/src/org/klomp/snark/I2PSnarkUtil.java
View File

@ -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 &lt; 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 &lt; 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 &lt; 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. ' -&gt; '' 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.

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

@ -385,7 +385,7 @@ class PeerCoordinator implements PeerListener
/**
* Inbound.
* Not halted, peers < max.
* Not halted, peers &lt; 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 &lt; max, and need pieces.
* @since 0.9.1
*/
public boolean needOutboundPeers() {

6
apps/i2psnark/java/src/org/klomp/snark/SnarkManager.java
View File

@ -324,7 +324,7 @@ public class SnarkManager implements CompleteListener {
/**
* Use if it does not include a link.
* Escapes '<' and '>' before queueing
* Escapes '&lt;' and '&gt;' before queueing
*/
public void addMessage(String message) {
addMessageNoEscape(message.replace("<", "&lt;").replace(">", "&gt;"));
@ -332,7 +332,7 @@ public class SnarkManager implements CompleteListener {
/**
* Use if it includes a link.
* Does not escape '<' and '>' before queueing
* Does not escape '&lt;' and '&gt;' 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 -&gt; webapp destroy() -&gt; 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

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

@ -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; &lt;0 to disable
* @since 0.8.1
*/
public void setPriority(int fileIndex, int pri) {

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

@ -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 &gt; 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 &lt;= 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.

14
apps/i2psnark/java/src/org/klomp/snark/dht/KRPC.java
View File

@ -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 &gt; 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 &gt; 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 &lt;= 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 &lt;= 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<Hash> if getReplyCode is REPLY_PEERS.
* Should contain List<NodeInfo> if getReplyCode is REPLY_NODES.
* Should contain String if getReplyCode is > 200.
* Should contain List&lt;Hash&gt; if getReplyCode is REPLY_PEERS.
* Should contain List&lt;NodeInfo&gt; if getReplyCode is REPLY_NODES.
* Should contain String if getReplyCode is &gt; 200.
* @return may be null depending on what happened. Cast to expected type.
*/
public Object getReplyObject() {

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

@ -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 &gt;= 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