THRIFT-3678 Fix javadoc errors on JDK 8
Client: Java
Patch: Nobuaki Sukegawa
This closes #898
diff --git a/lib/java/src/org/apache/thrift/async/TAsyncClient.java b/lib/java/src/org/apache/thrift/async/TAsyncClient.java
index 9a22717..005018a 100644
--- a/lib/java/src/org/apache/thrift/async/TAsyncClient.java
+++ b/lib/java/src/org/apache/thrift/async/TAsyncClient.java
@@ -66,7 +66,7 @@
/**
* Get the client's error - returns null if no error
- * @return Get the client's error. <br /> returns null if no error
+ * @return Get the client's error. <p> returns null if no error
*/
public Exception getError() {
return ___error;
diff --git a/lib/java/src/org/apache/thrift/async/TAsyncMethodCall.java b/lib/java/src/org/apache/thrift/async/TAsyncMethodCall.java
index 5c679b6..5bca17f 100644
--- a/lib/java/src/org/apache/thrift/async/TAsyncMethodCall.java
+++ b/lib/java/src/org/apache/thrift/async/TAsyncMethodCall.java
@@ -36,7 +36,7 @@
* Encapsulates an async method call
* Need to generate:
* - private void write_args(TProtocol protocol)
- * - public T getResult() throws <Exception_1>, <Exception_2>, ...
+ * - public T getResult() throws <Exception_1>, <Exception_2>, ...
* @param <T>
*/
public abstract class TAsyncMethodCall<T> {
diff --git a/lib/java/src/org/apache/thrift/protocol/TCompactProtocol.java b/lib/java/src/org/apache/thrift/protocol/TCompactProtocol.java
index 2a38810..56c349a 100644
--- a/lib/java/src/org/apache/thrift/protocol/TCompactProtocol.java
+++ b/lib/java/src/org/apache/thrift/protocol/TCompactProtocol.java
@@ -230,7 +230,7 @@
/**
* Write a field header containing the field id and field type. If the
- * difference between the current field id and the last one is small (< 15),
+ * difference between the current field id and the last one is small (< 15),
* then the field id will be encoded in the 4 MSB as a delta. Otherwise, the
* field id will follow the type header as a zigzag varint.
*/
diff --git a/lib/java/src/org/apache/thrift/protocol/TMultiplexedProtocol.java b/lib/java/src/org/apache/thrift/protocol/TMultiplexedProtocol.java
index 3535274..0ea566b 100644
--- a/lib/java/src/org/apache/thrift/protocol/TMultiplexedProtocol.java
+++ b/lib/java/src/org/apache/thrift/protocol/TMultiplexedProtocol.java
@@ -31,21 +31,23 @@
*
* <p>This example uses a single socket transport to invoke two services:
*
- * <blockquote><code>
- * TSocket transport = new TSocket("localhost", 9090);<br/>
- * transport.open();<br/>
- *<br/>
- * TBinaryProtocol protocol = new TBinaryProtocol(transport);<br/>
- *<br/>
- * TMultiplexedProtocol mp = new TMultiplexedProtocol(protocol, "Calculator");<br/>
- * Calculator.Client service = new Calculator.Client(mp);<br/>
- *<br/>
- * TMultiplexedProtocol mp2 = new TMultiplexedProtocol(protocol, "WeatherReport");<br/>
- * WeatherReport.Client service2 = new WeatherReport.Client(mp2);<br/>
- *<br/>
- * System.out.println(service.add(2,2));<br/>
- * System.out.println(service2.getTemperature());<br/>
- * </code></blockquote>
+ * <pre>
+ * {@code
+ * TSocket transport = new TSocket("localhost", 9090);
+ * transport.open();
+ *
+ * TBinaryProtocol protocol = new TBinaryProtocol(transport);
+ *
+ * TMultiplexedProtocol mp = new TMultiplexedProtocol(protocol, "Calculator");
+ * Calculator.Client service = new Calculator.Client(mp);
+ *
+ * TMultiplexedProtocol mp2 = new TMultiplexedProtocol(protocol, "WeatherReport");
+ * WeatherReport.Client service2 = new WeatherReport.Client(mp2);
+ *
+ * System.out.println(service.add(2,2));
+ * System.out.println(service2.getTemperature());
+ * }
+ * </pre>
*
* @see org.apache.thrift.protocol.TProtocolDecorator
*/
diff --git a/lib/java/src/org/apache/thrift/protocol/TProtocolUtil.java b/lib/java/src/org/apache/thrift/protocol/TProtocolUtil.java
index 752520a..b76f8ea 100644
--- a/lib/java/src/org/apache/thrift/protocol/TProtocolUtil.java
+++ b/lib/java/src/org/apache/thrift/protocol/TProtocolUtil.java
@@ -152,7 +152,7 @@
* In some cases, no guess can be done, in that case we return the
* fallback TProtocolFactory.
* To be certain to correctly detect the protocol, the first encoded
- * field should have a field id < 256
+ * field should have a field id < 256
*
* @param data The serialized data to guess the protocol for.
* @param fallback The TProtocol to return if no guess can be made.
diff --git a/lib/java/src/org/apache/thrift/server/THsHaServer.java b/lib/java/src/org/apache/thrift/server/THsHaServer.java
index 2414e49..3b8fb35 100644
--- a/lib/java/src/org/apache/thrift/server/THsHaServer.java
+++ b/lib/java/src/org/apache/thrift/server/THsHaServer.java
@@ -131,7 +131,7 @@
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
protected void waitForShutdown() {
diff --git a/lib/java/src/org/apache/thrift/transport/TFileProcessor.java b/lib/java/src/org/apache/thrift/transport/TFileProcessor.java
index 4e6a198..96087d1 100644
--- a/lib/java/src/org/apache/thrift/transport/TFileProcessor.java
+++ b/lib/java/src/org/apache/thrift/transport/TFileProcessor.java
@@ -27,8 +27,6 @@
/**
* FileProcessor: helps in processing files generated by TFileTransport.
* Port of original cpp implementation
- *
- * @author Joydeep Sen Sarma <jssarma@facebook.com>
*/
public class TFileProcessor {
diff --git a/lib/java/src/org/apache/thrift/transport/TFileTransport.java b/lib/java/src/org/apache/thrift/transport/TFileTransport.java
index 0044d2a..915fa73 100644
--- a/lib/java/src/org/apache/thrift/transport/TFileTransport.java
+++ b/lib/java/src/org/apache/thrift/transport/TFileTransport.java
@@ -33,8 +33,6 @@
* It may make better sense to provide a basic stream access on top of the framed file format
* The FileTransport can then be a user of this framed file format with some additional logic
* for chunking.
- *
- * @author Joydeep Sen Sarma <jssarma@facebook.com>
*/
public class TFileTransport extends TTransport {
diff --git a/lib/java/src/org/apache/thrift/transport/TNonblockingSocket.java b/lib/java/src/org/apache/thrift/transport/TNonblockingSocket.java
index 23f8574..f86a48b 100644
--- a/lib/java/src/org/apache/thrift/transport/TNonblockingSocket.java
+++ b/lib/java/src/org/apache/thrift/transport/TNonblockingSocket.java
@@ -55,7 +55,6 @@
* Create a new nonblocking socket transport that will be connected to host:port.
* @param host
* @param port
- * @throws TTransportException
* @throws IOException
*/
public TNonblockingSocket(String host, int port, int timeout) throws IOException {
diff --git a/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java b/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java
index 7f63b07..9c60ed1 100755
--- a/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java
+++ b/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java
@@ -49,9 +49,9 @@
* from System properties that are set.
*
* Example system properties:
- * -Djavax.net.ssl.trustStore=<truststore location>
+ * -Djavax.net.ssl.trustStore=<truststore location>
* -Djavax.net.ssl.trustStorePassword=password
- * -Djavax.net.ssl.keyStore=<keystore location>
+ * -Djavax.net.ssl.keyStore=<keystore location>
* -Djavax.net.ssl.keyStorePassword=password
*
* @param port
diff --git a/lib/java/src/org/apache/thrift/transport/TSaslServerTransport.java b/lib/java/src/org/apache/thrift/transport/TSaslServerTransport.java
index c883c8f..b5b8e7d 100644
--- a/lib/java/src/org/apache/thrift/transport/TSaslServerTransport.java
+++ b/lib/java/src/org/apache/thrift/transport/TSaslServerTransport.java
@@ -145,7 +145,7 @@
/**
* <code>TTransportFactory</code> to create
- * <code>TSaslServerTransports<c/ode>. Ensures that a given
+ * <code>TSaslServerTransports</code>. Ensures that a given
* underlying <code>TTransport</code> instance receives the same
* <code>TSaslServerTransport</code>. This is kind of an awful hack to work
* around the fact that Thrift is designed assuming that
diff --git a/lib/java/src/org/apache/thrift/transport/TSaslTransport.java b/lib/java/src/org/apache/thrift/transport/TSaslTransport.java
index 7938916..5bfea5b 100644
--- a/lib/java/src/org/apache/thrift/transport/TSaslTransport.java
+++ b/lib/java/src/org/apache/thrift/transport/TSaslTransport.java
@@ -35,7 +35,7 @@
/**
* A superclass for SASL client/server thrift transports. A subclass need only
- * implement the <code>open</open> method.
+ * implement the <code>open</code> method.
*/
abstract class TSaslTransport extends TTransport {