From 177f595f333e59056c38e21ca6c53f2529f0a989 Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Tue, 4 Dec 2018 20:34:51 +0000
Subject: [PATCH] Javadoc fixes NDT log tweaks
---
.../src/edu/internet2/ndt/OsfwWorker.java | 6 ++---
.../java/src/edu/internet2/ndt/Tcpbw100.java | 22 +++++++++----------
.../streaming/impl/I2PServerSocketFull.java | 2 +-
.../streaming/impl/I2PSocketManagerFull.java | 2 +-
core/java/src/org/json/simple/ItemList.java | 8 +++----
core/java/src/org/json/simple/JSONArray.java | 2 +-
core/java/src/org/json/simple/JSONAware.java | 2 +-
core/java/src/org/json/simple/JSONObject.java | 2 +-
.../src/org/json/simple/JSONStreamAware.java | 2 +-
core/java/src/org/json/simple/JSONValue.java | 2 +-
.../json/simple/parser/ContainerFactory.java | 2 +-
.../json/simple/parser/ContentHandler.java | 2 +-
.../org/json/simple/parser/JSONParser.java | 4 +---
.../json/simple/parser/ParseException.java | 2 +-
.../src/org/json/simple/parser/Yytoken.java | 2 +-
15 files changed, 30 insertions(+), 32 deletions(-)
diff --git a/apps/routerconsole/java/src/edu/internet2/ndt/OsfwWorker.java b/apps/routerconsole/java/src/edu/internet2/ndt/OsfwWorker.java
index c9d1f11bf0..2eb4bbf98a 100644
--- a/apps/routerconsole/java/src/edu/internet2/ndt/OsfwWorker.java
+++ b/apps/routerconsole/java/src/edu/internet2/ndt/OsfwWorker.java
@@ -7,7 +7,7 @@ import java.net.Socket;
/**
* OsfwWorker creates a thread that listens for a message from the server. It
* functions to check if the server has sent a message that is valid and
- * sufficient to determine if the server->client direction has a fire-wall.
+ * sufficient to determine if the server->client direction has a fire-wall.
*
* <p>
* As part of the simple firewall test, the Server must try to connect to the
@@ -49,7 +49,7 @@ public class OsfwWorker implements Runnable {
* @param iParamTestTime
* Test time duration to wait for message from server
* @param _localParam
- * Applet object used to set the result of the S->C firewall test
+ * Applet object used to set the result of the S->C firewall test
*/
OsfwWorker(ServerSocket srvSocketParam, int iParamTestTime,
Tcpbw100 _localParam) {
@@ -76,7 +76,7 @@ public class OsfwWorker implements Runnable {
/**
* run() method of this SFW Worker thread. This thread listens on the socket
* from the server for a given time period, and checks to see if the server
- * has sent a message that is valid and sufficient to determine if the S->C
+ * has sent a message that is valid and sufficient to determine if the S->C
* direction has a fire-wall.
* */
public void run() {
diff --git a/apps/routerconsole/java/src/edu/internet2/ndt/Tcpbw100.java b/apps/routerconsole/java/src/edu/internet2/ndt/Tcpbw100.java
index 6812fa6e2c..e3100b76cf 100644
--- a/apps/routerconsole/java/src/edu/internet2/ndt/Tcpbw100.java
+++ b/apps/routerconsole/java/src/edu/internet2/ndt/Tcpbw100.java
@@ -563,38 +563,38 @@ public class Tcpbw100 extends JApplet implements ActionListener {
}
/**
- * Get Client->Server fire-wall test results.
+ * Get Client->Server fire-wall test results.
*
- * @return integer indicating C->S test results
+ * @return integer indicating C->S test results
* */
public int getC2sSFWTestResults() {
return this._iC2sSFWResult;
}
/**
- * Set Client->Server fire-wall test results.
+ * Set Client->Server fire-wall test results.
*
* @param iParamC2SRes
- * integer indicating C->S test results
+ * integer indicating C->S test results
* */
public void setC2sSFWTestResults(int iParamC2SRes) {
this._iC2sSFWResult = iParamC2SRes;
}
/**
- * Get Server->Client fire-wall test results.
+ * Get Server->Client fire-wall test results.
*
- * @return integer indicating C->S test results
+ * @return integer indicating C->S test results
* */
public int getS2cSFWTestResults() {
return this._iS2cSFWResult;
}
/**
- * Set server->Client fire-wall test results.
+ * Set server->Client fire-wall test results.
*
* @param iParamS2CRes
- * integer indicating C->S test results
+ * integer indicating C->S test results
* */
public void setS2cSFWTestResults(int iParamS2CRes) {
this._iS2cSFWResult = iParamS2CRes;
@@ -4548,7 +4548,7 @@ public class Tcpbw100 extends JApplet implements ActionListener {
try {
t.interrupt();
} catch (RuntimeException re) {
- _log.warn("TG", re);
+ _log.debug("TG", re);
}
try {
Thread.sleep(20);
@@ -4559,7 +4559,7 @@ public class Tcpbw100 extends JApplet implements ActionListener {
try {
t.stop();
} catch (RuntimeException re) {
- _log.warn("TG", re);
+ _log.debug("TG", re);
}
}
}
@@ -4571,7 +4571,7 @@ public class Tcpbw100 extends JApplet implements ActionListener {
thread_group.destroy();
break;
}catch( Throwable e ){
- _log.warn("TG", e);
+ _log.debug("TG", e);
}
}
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PServerSocketFull.java b/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PServerSocketFull.java
index 28b615370e..f5595182fb 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PServerSocketFull.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PServerSocketFull.java
@@ -30,7 +30,7 @@ class I2PServerSocketFull implements I2PServerSocket {
*
* @throws I2PException if there is a problem with reading a new socket
* from the data available (e.g. the I2PSession is closed)
- * @throws RouterRestartException (extends I2PException) if the router is apparently restarting, since 0.9.34
+ * @throws net.i2p.client.streaming.RouterRestartException (extends I2PException) if the router is apparently restarting, since 0.9.34
* @throws ConnectException if the I2PServerSocket is closed, or if interrupted.
* Not actually thrown through 0.9.16; thrown as of 0.9.17
* @throws SocketTimeoutException if a timeout was previously set with setSoTimeout and the timeout has been reached.
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PSocketManagerFull.java b/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PSocketManagerFull.java
index 66ca1b491a..48d125e772 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PSocketManagerFull.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/impl/I2PSocketManagerFull.java
@@ -350,7 +350,7 @@ public class I2PSocketManagerFull implements I2PSocketManager {
*
* @return connected I2PSocket, or null through 0.9.16, non-null as of 0.9.17
* @throws I2PException if session is closed
- * @throws RouterRestartException (extends I2PException) if the router is apparently restarting, since 0.9.34
+ * @throws net.i2p.client.streaming.RouterRestartException (extends I2PException) if the router is apparently restarting, since 0.9.34
* @throws ConnectException (since 0.9.17; I2PServerSocket interface always declared it)
* @throws SocketTimeoutException if a timeout was previously set with setSoTimeout and the timeout has been reached.
*/
diff --git a/core/java/src/org/json/simple/ItemList.java b/core/java/src/org/json/simple/ItemList.java
index 3d1213a11f..a9504f058c 100644
--- a/core/java/src/org/json/simple/ItemList.java
+++ b/core/java/src/org/json/simple/ItemList.java
@@ -9,10 +9,10 @@ import java.util.List;
import java.util.StringTokenizer;
/**
- * |a:b:c| => |a|,|b|,|c|
- * |:| => ||,||
- * |a:| => |a|,||
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * |a:b:c| => |a|,|b|,|c|
+ * |:| => ||,||
+ * |a:| => |a|,||
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public class ItemList {
private String sp=",";
diff --git a/core/java/src/org/json/simple/JSONArray.java b/core/java/src/org/json/simple/JSONArray.java
index 57167f482f..e484d9e228 100644
--- a/core/java/src/org/json/simple/JSONArray.java
+++ b/core/java/src/org/json/simple/JSONArray.java
@@ -14,7 +14,7 @@ import java.util.List;
/**
* A JSON array. JSONObject supports java.util.List interface.
*
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public class JSONArray extends ArrayList implements List, JSONAware, JSONStreamAware {
private static final long serialVersionUID = 3957988303675231981L;
diff --git a/core/java/src/org/json/simple/JSONAware.java b/core/java/src/org/json/simple/JSONAware.java
index 89f1525104..b92771113e 100644
--- a/core/java/src/org/json/simple/JSONAware.java
+++ b/core/java/src/org/json/simple/JSONAware.java
@@ -2,7 +2,7 @@ package org.json.simple;
/**
* Beans that support customized output of JSON text shall implement this interface.
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public interface JSONAware {
/**
diff --git a/core/java/src/org/json/simple/JSONObject.java b/core/java/src/org/json/simple/JSONObject.java
index e1dbf266ce..60eeecbb2c 100644
--- a/core/java/src/org/json/simple/JSONObject.java
+++ b/core/java/src/org/json/simple/JSONObject.java
@@ -13,7 +13,7 @@ import java.util.Map;
/**
* A JSON object. Key value pairs are unordered. JSONObject supports java.util.Map interface.
*
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public class JSONObject extends HashMap implements Map, JSONAware, JSONStreamAware{
diff --git a/core/java/src/org/json/simple/JSONStreamAware.java b/core/java/src/org/json/simple/JSONStreamAware.java
index c2287c459e..29e3ce9bfa 100644
--- a/core/java/src/org/json/simple/JSONStreamAware.java
+++ b/core/java/src/org/json/simple/JSONStreamAware.java
@@ -5,7 +5,7 @@ import java.io.Writer;
/**
* Beans that support customized output of JSON text to a writer shall implement this interface.
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public interface JSONStreamAware {
/**
diff --git a/core/java/src/org/json/simple/JSONValue.java b/core/java/src/org/json/simple/JSONValue.java
index fc9fab254d..a236401b72 100644
--- a/core/java/src/org/json/simple/JSONValue.java
+++ b/core/java/src/org/json/simple/JSONValue.java
@@ -16,7 +16,7 @@ import org.json.simple.parser.ParseException;
/**
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public class JSONValue {
/**
diff --git a/core/java/src/org/json/simple/parser/ContainerFactory.java b/core/java/src/org/json/simple/parser/ContainerFactory.java
index 366ac4dead..5ff4ce1727 100644
--- a/core/java/src/org/json/simple/parser/ContainerFactory.java
+++ b/core/java/src/org/json/simple/parser/ContainerFactory.java
@@ -8,7 +8,7 @@ import java.util.Map;
*
* @see org.json.simple.parser.JSONParser#parse(java.io.Reader, ContainerFactory)
*
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public interface ContainerFactory {
/**
diff --git a/core/java/src/org/json/simple/parser/ContentHandler.java b/core/java/src/org/json/simple/parser/ContentHandler.java
index ae8d065579..36dcfd7bf8 100644
--- a/core/java/src/org/json/simple/parser/ContentHandler.java
+++ b/core/java/src/org/json/simple/parser/ContentHandler.java
@@ -8,7 +8,7 @@ import java.io.IOException;
* @see org.xml.sax.ContentHandler
* @see org.json.simple.parser.JSONParser#parse(java.io.Reader, ContentHandler, boolean)
*
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public interface ContentHandler {
/**
diff --git a/core/java/src/org/json/simple/parser/JSONParser.java b/core/java/src/org/json/simple/parser/JSONParser.java
index 9acaa377fe..a32d81cc00 100644
--- a/core/java/src/org/json/simple/parser/JSONParser.java
+++ b/core/java/src/org/json/simple/parser/JSONParser.java
@@ -18,7 +18,7 @@ import org.json.simple.JSONObject;
/**
* Parser for JSON text. Please note that JSONParser is NOT thread-safe.
*
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public class JSONParser {
public static final int S_INIT=0;
@@ -56,8 +56,6 @@ public class JSONParser {
* Reset the parser to the initial state with a new character reader.
*
* @param in - The new character reader.
- * @throws IOException
- * @throws ParseException
*/
public void reset(Reader in){
lexer.yyreset(in);
diff --git a/core/java/src/org/json/simple/parser/ParseException.java b/core/java/src/org/json/simple/parser/ParseException.java
index f497cd9f89..39f95f6160 100644
--- a/core/java/src/org/json/simple/parser/ParseException.java
+++ b/core/java/src/org/json/simple/parser/ParseException.java
@@ -3,7 +3,7 @@ package org.json.simple.parser;
/**
* ParseException explains why and where the error occurs in source JSON text.
*
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*
*/
public class ParseException extends Exception {
diff --git a/core/java/src/org/json/simple/parser/Yytoken.java b/core/java/src/org/json/simple/parser/Yytoken.java
index ff14e27c1b..c8b3ca7e26 100644
--- a/core/java/src/org/json/simple/parser/Yytoken.java
+++ b/core/java/src/org/json/simple/parser/Yytoken.java
@@ -5,7 +5,7 @@
package org.json.simple.parser;
/**
- * @author FangYidong<fangyidong@yahoo.com.cn>
+ * @author FangYidong fangyidong@yahoo.com.cn
*/
public class Yytoken {
public static final int TYPE_VALUE=0;//JSON primitive value: string,number,boolean,null
--
GitLab