You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@thrift.apache.org by ro...@apache.org on 2011/08/23 22:27:20 UTC
svn commit: r1160883 - in /thrift/trunk/lib/java/src/org/apache/thrift: ./
async/ protocol/ transport/
Author: roger
Date: Tue Aug 23 20:27:19 2011
New Revision: 1160883
URL: http://svn.apache.org/viewvc?rev=1160883&view=rev
Log:
THRIFT-1278 javadoc warnings - compilation
Patch: Aravind Srini
Modified:
thrift/trunk/lib/java/src/org/apache/thrift/TServiceClient.java
thrift/trunk/lib/java/src/org/apache/thrift/TServiceClientFactory.java
thrift/trunk/lib/java/src/org/apache/thrift/TUnion.java
thrift/trunk/lib/java/src/org/apache/thrift/async/TAsyncClient.java
thrift/trunk/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java
thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileProcessor.java
thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileTransport.java
thrift/trunk/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java
thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransport.java
Modified: thrift/trunk/lib/java/src/org/apache/thrift/TServiceClient.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/TServiceClient.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/TServiceClient.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/TServiceClient.java Tue Aug 23 20:27:19 2011
@@ -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_;
Modified: thrift/trunk/lib/java/src/org/apache/thrift/TServiceClientFactory.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/TServiceClientFactory.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/TServiceClientFactory.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/TServiceClientFactory.java Tue Aug 23 20:27:19 2011
@@ -30,7 +30,7 @@ public interface TServiceClientFactory<T
/**
* Get a brand-new T using <i>prot</i> as both the input and output protocol.
* @param prot
- * @return
+ * @return A brand-new T using <i>prot</i> as both the input and output protocol.
*/
public T getClient(TProtocol prot);
@@ -39,7 +39,7 @@ public interface TServiceClientFactory<T
* 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);
}
Modified: thrift/trunk/lib/java/src/org/apache/thrift/TUnion.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/TUnion.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/TUnion.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/TUnion.java Tue Aug 23 20:27:19 2011
@@ -179,7 +179,7 @@ public abstract class TUnion<T extends T
* 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;
Modified: thrift/trunk/lib/java/src/org/apache/thrift/async/TAsyncClient.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/async/TAsyncClient.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/async/TAsyncClient.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/async/TAsyncClient.java Tue Aug 23 20:27:19 2011
@@ -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. <br /> returns null if no error
*/
public Exception getError() {
return ___error;
Modified: thrift/trunk/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/protocol/TTupleProtocol.java Tue Aug 23 20:27:19 2011
@@ -82,7 +82,7 @@ public final class TTupleProtocol extend
* 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];
Modified: thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileProcessor.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileProcessor.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileProcessor.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileProcessor.java Tue Aug 23 20:27:19 2011
@@ -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();
Modified: thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileTransport.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileTransport.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileTransport.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/transport/TFileTransport.java Tue Aug 23 20:27:19 2011
@@ -418,7 +418,7 @@ public class TFileTransport extends TTra
/**
* 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) {
Modified: thrift/trunk/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/transport/TSSLTransportFactory.java Tue Aug 23 20:27:19 2011
@@ -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;
Modified: thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransport.java
URL: http://svn.apache.org/viewvc/thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransport.java?rev=1160883&r1=1160882&r2=1160883&view=diff
==============================================================================
--- thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransport.java (original)
+++ thrift/trunk/lib/java/src/org/apache/thrift/transport/TTransport.java Tue Aug 23 20:27:19 2011
@@ -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. <br> Returns -1 if
+ * this is a non-buffered transport.
*/
public int getBytesRemainingInBuffer() {
return -1;