From b7d7227eb0b11f3a8009d45fbbc7745ad2cbfb8c Mon Sep 17 00:00:00 2001 From: Roger Meier Date: Tue, 23 Aug 2011 20:27:19 +0000 Subject: [PATCH] THRIFT-1278 javadoc warnings - compilation Patch: Aravind Srini git-svn-id: https://svn.apache.org/repos/asf/thrift/trunk@1160883 13f79535-47bb-0310-9956-ffa450edef68 --- lib/java/src/org/apache/thrift/TServiceClient.java | 4 ++-- lib/java/src/org/apache/thrift/TServiceClientFactory.java | 4 ++-- lib/java/src/org/apache/thrift/TUnion.java | 2 +- lib/java/src/org/apache/thrift/async/TAsyncClient.java | 4 ++-- .../src/org/apache/thrift/protocol/TTupleProtocol.java | 2 +- .../src/org/apache/thrift/transport/TFileProcessor.java | 2 +- .../src/org/apache/thrift/transport/TFileTransport.java | 2 +- .../org/apache/thrift/transport/TSSLTransportFactory.java | 2 +- lib/java/src/org/apache/thrift/transport/TTransport.java | 8 +++++--- 9 files changed, 16 insertions(+), 14 deletions(-) diff --git a/lib/java/src/org/apache/thrift/TServiceClient.java b/lib/java/src/org/apache/thrift/TServiceClient.java index c70e66f8..15715f10 100644 --- a/lib/java/src/org/apache/thrift/TServiceClient.java +++ b/lib/java/src/org/apache/thrift/TServiceClient.java @@ -44,7 +44,7 @@ public abstract class TServiceClient { /** * Get the TProtocol being used as the input (read) protocol. - * @return + * @return the TProtocol being used as the input (read) protocol. */ public TProtocol getInputProtocol() { return this.iprot_; @@ -52,7 +52,7 @@ public abstract class TServiceClient { /** * Get the TProtocol being used as the output (write) protocol. - * @return + * @return the TProtocol being used as the output (write) protocol. */ public TProtocol getOutputProtocol() { return this.oprot_; diff --git a/lib/java/src/org/apache/thrift/TServiceClientFactory.java b/lib/java/src/org/apache/thrift/TServiceClientFactory.java index 808d5e60..988e6559 100644 --- a/lib/java/src/org/apache/thrift/TServiceClientFactory.java +++ b/lib/java/src/org/apache/thrift/TServiceClientFactory.java @@ -30,7 +30,7 @@ public interface TServiceClientFactory { /** * Get a brand-new T using prot as both the input and output protocol. * @param prot - * @return + * @return A brand-new T using prot as both the input and output protocol. */ public T getClient(TProtocol prot); @@ -39,7 +39,7 @@ public interface TServiceClientFactory { * input and output protocols may be the same instance. * @param iprot * @param oprot - * @return + * @return a brand new T using the specified input and output protocols */ public T getClient(TProtocol iprot, TProtocol oprot); } diff --git a/lib/java/src/org/apache/thrift/TUnion.java b/lib/java/src/org/apache/thrift/TUnion.java index 1962c80b..240163f2 100644 --- a/lib/java/src/org/apache/thrift/TUnion.java +++ b/lib/java/src/org/apache/thrift/TUnion.java @@ -179,7 +179,7 @@ public abstract class TUnion, F extends TFieldIdEnum> impl * Implementation should be generated to read the right stuff from the wire * based on the field header. * @param field - * @return + * @return read Object based on the field header, as specified by the argument. */ protected abstract Object readValue(TProtocol iprot, TField field) throws TException; diff --git a/lib/java/src/org/apache/thrift/async/TAsyncClient.java b/lib/java/src/org/apache/thrift/async/TAsyncClient.java index d3b009a2..9a227179 100644 --- a/lib/java/src/org/apache/thrift/async/TAsyncClient.java +++ b/lib/java/src/org/apache/thrift/async/TAsyncClient.java @@ -58,7 +58,7 @@ public abstract class TAsyncClient { /** * Is the client in an error state? - * @return + * @return If client in an error state? */ public boolean hasError() { return ___error != null; @@ -66,7 +66,7 @@ public abstract class TAsyncClient { /** * Get the client's error - returns null if no error - * @return + * @return Get the client's error.
returns null if no error */ public Exception getError() { return ___error; diff --git a/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java b/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java index 5e9a14e6..4592738d 100644 --- a/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java +++ b/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java @@ -82,7 +82,7 @@ public final class TTupleProtocol extends TCompactProtocol { * assumed to be the least significant bit. * * @param bits - * @return + * @return a byte array of at least length 1 */ public static byte[] toByteArray(BitSet bits) { byte[] bytes = new byte[bits.length() / 8 + 1]; diff --git a/lib/java/src/org/apache/thrift/transport/TFileProcessor.java b/lib/java/src/org/apache/thrift/transport/TFileProcessor.java index 7a58eea4..19db8969 100644 --- a/lib/java/src/org/apache/thrift/transport/TFileProcessor.java +++ b/lib/java/src/org/apache/thrift/transport/TFileProcessor.java @@ -95,7 +95,7 @@ public class TFileProcessor { * Process from start to last chunk both inclusive where chunks begin from 0 * @param startChunkNum first chunk to be processed - * @param lastChunkNum last chunk to be processed + * @param endChunkNum last chunk to be processed */ public void processChunk(int startChunkNum, int endChunkNum) throws TException { int numChunks = inputTransport_.getNumChunks(); diff --git a/lib/java/src/org/apache/thrift/transport/TFileTransport.java b/lib/java/src/org/apache/thrift/transport/TFileTransport.java index 24a884fa..f5abe536 100644 --- a/lib/java/src/org/apache/thrift/transport/TFileTransport.java +++ b/lib/java/src/org/apache/thrift/transport/TFileTransport.java @@ -418,7 +418,7 @@ public class TFileTransport extends TTransport { /** * File Transport ctor * - * @param inputFile_ open TSeekableFile to read/write from + * @param inputFile open TSeekableFile to read/write from * @param readOnly Whether this is a read-only transport */ public TFileTransport(TSeekableFile inputFile, boolean readOnly) { diff --git a/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java b/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java index 1e1c4c99..ae4544e2 100644 --- a/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java +++ b/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java @@ -323,7 +323,7 @@ public class TSSLTransportFactory { /** * Set if client authentication is required * - * @param auth + * @param clientAuth */ public void requireClientAuth(boolean clientAuth) { this.clientAuth = clientAuth; diff --git a/lib/java/src/org/apache/thrift/transport/TTransport.java b/lib/java/src/org/apache/thrift/transport/TTransport.java index c9f3e93f..6eab3b04 100644 --- a/lib/java/src/org/apache/thrift/transport/TTransport.java +++ b/lib/java/src/org/apache/thrift/transport/TTransport.java @@ -127,7 +127,7 @@ public abstract class TTransport { /** * Access the protocol's underlying buffer directly. If this is not a * buffered transport, return null. - * @return + * @return protocol's Underlying buffer */ public byte[] getBuffer() { return null; @@ -136,7 +136,8 @@ public abstract class TTransport { /** * Return the index within the underlying buffer that specifies the next spot * that should be read from. - * @return + * @return index within the underlying buffer that specifies the next spot + * that should be read from */ public int getBufferPosition() { return 0; @@ -145,7 +146,8 @@ public abstract class TTransport { /** * Get the number of bytes remaining in the underlying buffer. Returns -1 if * this is a non-buffered transport. - * @return + * @return the number of bytes remaining in the underlying buffer.
Returns -1 if + * this is a non-buffered transport. */ public int getBytesRemainingInBuffer() { return -1; -- 2.17.1