Author: markt
Date: Mon Jan 27 18:19:12 2014
New Revision: 1561773
URL: http://svn.apache.org/r1561773
Log:
Fix Javadoc warnings
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/ChannelCoordinator.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ChannelData.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/DirectByteArrayOutputStream.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ReplicationStream.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/MemberImpl.java
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/Membership.java
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java
Mon Jan 27 18:19:12 2014
@@ -1715,7 +1715,7 @@ public class DefaultServlet
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
- * @param resourceInfo File object
+ * @param resourceAttributes Attributes of requested resource
* @return boolean true if the resource meets the specified condition,
* and false if the condition is not satisfied, in which case request
* processing is stopped
@@ -1775,7 +1775,7 @@ public class DefaultServlet
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
- * @param resourceInfo File object
+ * @param resourceAttributes Attributes of requested resource
* @return boolean true if the resource meets the specified condition,
* and false if the condition is not satisfied, in which case request
* processing is stopped
@@ -1808,7 +1808,7 @@ public class DefaultServlet
* output stream, and ensure that both streams are closed before returning
* (even in the face of an exception).
*
- * @param resourceInfo The resource information
+ * @param cacheEntry Cached version of requested resource
* @param ostream The output stream to write to
*
* @exception IOException if an input/output error occurs
@@ -1854,7 +1854,7 @@ public class DefaultServlet
* output stream, and ensure that both streams are closed before returning
* (even in the face of an exception).
*
- * @param resourceInfo The resource info
+ * @param cacheEntry Cached version of requested resource
* @param writer The writer to write to
*
* @exception IOException if an input/output error occurs
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/ChannelCoordinator.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/ChannelCoordinator.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
---
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/ChannelCoordinator.java
(original)
+++
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/ChannelCoordinator.java
Mon Jan 27 18:19:12 2014
@@ -70,8 +70,6 @@ public class ChannelCoordinator extends
* Send a message to one or more members in the cluster
* @param destination Member[] - the destinations, null or zero length
means all
* @param msg ClusterMessage - the message to send
- * @param options int - sender options, see class documentation
- * @return ClusterMessage[] - the replies from the members, if any.
*/
public void sendMessage(Member[] destination, ChannelMessage msg,
InterceptorPayload payload) throws ChannelException {
if ( destination == null ) destination =
membershipService.getMembers();
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
Mon Jan 27 18:19:12 2014
@@ -64,7 +64,7 @@ public class RpcChannel implements Chann
* Send a message and wait for the response.
* @param destination Member[] - the destination for the message, and the
members you request a reply from
* @param message Serializable - the message you are sending out
- * @param options int - FIRST_REPLY, MAJORITY_REPLY or ALL_REPLY
+ * @param rpcOptions int - FIRST_REPLY, MAJORITY_REPLY, ALL_REPLY or
NO_REPLY
* @param timeout long - timeout in milliseconds, if no reply is received
within this time null is returned
* @return Response[] - an array of response objects.
* @throws ChannelException
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ChannelData.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ChannelData.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ChannelData.java
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ChannelData.java
Mon Jan 27 18:19:12 2014
@@ -136,7 +136,7 @@ public class ChannelData implements Chan
return options;
}
/**
- * @param sets the message options
+ * @param options sets the message options
*/
public void setOptions(int options) {
this.options = options;
@@ -215,8 +215,6 @@ public class ChannelData implements Chan
/**
* Deserializes a ChannelData object from a byte array
- * @param b byte[]
- * @return ChannelData
*/
public static ChannelData getDataFromPackage(XByteBuffer xbuf) {
ChannelData data = new ChannelData(false);
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/DirectByteArrayOutputStream.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/DirectByteArrayOutputStream.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
---
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/DirectByteArrayOutputStream.java
(original)
+++
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/DirectByteArrayOutputStream.java
Mon Jan 27 18:19:12 2014
@@ -41,7 +41,6 @@ public class DirectByteArrayOutputStream
* @throws IOException if an I/O error occurs. In particular, an
* <code>IOException</code> may be thrown if the output stream has
* been closed.
- * @todo Implement this java.io.OutputStream method
*/
public void write(int b) throws IOException {
buffer.append((byte)b);
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java
Mon Jan 27 18:19:12 2014
@@ -23,8 +23,6 @@ import java.nio.channels.SocketChannel;
import org.apache.catalina.tribes.ChannelMessage;
-
-
/**
* The object reader object is an object used in conjunction with
* java.nio TCP messages. This object stores the message bytes in a
@@ -86,17 +84,16 @@ public class ObjectReader {
* Append new bytes to buffer.
* @see XByteBuffer#countPackages()
* @param data new transfer buffer
- * @param off offset
* @param len length in buffer
- * @return number of messages that sended to callback
+ * @return number of messages that sent to callback
* @throws java.io.IOException
*/
public int append(ByteBuffer data, int len, boolean count) throws
java.io.IOException {
- buffer.append(data,len);
- int pkgCnt = -1;
- if ( count ) pkgCnt = buffer.countPackages();
- return pkgCnt;
- }
+ buffer.append(data,len);
+ int pkgCnt = -1;
+ if ( count ) pkgCnt = buffer.countPackages();
+ return pkgCnt;
+ }
public int append(byte[] data,int off,int len, boolean count) throws
java.io.IOException {
buffer.append(data,off,len);
@@ -109,7 +106,7 @@ public class ObjectReader {
* Send buffer to cluster listener (callback).
* Is message complete receiver send message to callback?
*
- * @see
org.apache.catalina.tribes.transport.ClusterReceiverBase#messageDataReceived(ChannelMessage)
+ * @see
org.apache.catalina.tribes.transport.ReceiverBase#messageDataReceived(ChannelMessage)
* @see XByteBuffer#doesPackageExist()
* @see XByteBuffer#extractPackage(boolean)
*
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ReplicationStream.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ReplicationStream.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
---
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ReplicationStream.java
(original)
+++
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/ReplicationStream.java
Mon Jan 27 18:19:12 2014
@@ -14,8 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.catalina.tribes.io;
import java.io.IOException;
@@ -35,7 +33,6 @@ import java.lang.reflect.Proxy;
* @author Filip Hanik
* @version $Id$
*/
-
public final class ReplicationStream extends ObjectInputStream {
@@ -48,7 +45,7 @@ public final class ReplicationStream ext
* Construct a new instance of CustomObjectInputStream
*
* @param stream The input stream we will read from
- * @param classLoader The class loader used to instantiate objects
+ * @param classLoaders The class loaders used to instantiate objects
*
* @exception IOException if an input/output error occurs
*/
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java
Mon Jan 27 18:19:12 2014
@@ -92,7 +92,8 @@ public class XByteBuffer
/**
* Constructs a new XByteBuffer
* @param size - the initial size of the byte buffer
- * @todo use a pool of byte[] for performance
+ *
+ * TODO use a pool of byte[] for performance
*/
public XByteBuffer(int size, boolean discard) {
buf = new byte[size];
@@ -154,7 +155,6 @@ public class XByteBuffer
* Appends the data to the buffer. If the data is incorrectly formatted,
ie, the data should always start with the
* header, false will be returned and the data will be discarded.
* @param b - bytes to be appended
- * @param off - the offset to extract data from
* @param len - the number of bytes to append.
* @return true if the data was appended correctly. Returns false if the
package is incorrect, ie missing header or something, or the length of data is 0
*/
@@ -339,10 +339,8 @@ public class XByteBuffer
/**
* Creates a complete data package
- * @param indata - the message data to be contained within the package
- * @param compressed - compression flag for the indata buffer
+ * @param cdata - the message data to be contained within the package
* @return - a full package (header,size,data,footer)
- *
*/
public static byte[] createDataPackage(ChannelData cdata) {
// return createDataPackage(cdata.getDataPackage());
@@ -432,8 +430,8 @@ public class XByteBuffer
/**
- * Converts an integer to four bytes
- * @param n - the integer
+ * Converts an boolean to four bytes
+ * @param bool - the boolean
* @return - four bytes in an array
* @deprecated use toBytes(boolean,byte[],int)
*/
@@ -448,11 +446,7 @@ public class XByteBuffer
return data;
}
- /**
- *
- * @param <any> long
- * @return use
- */
+
public static boolean toBoolean(byte[] b, int offset) {
return b[offset] != 0;
}
@@ -588,9 +582,6 @@ public class XByteBuffer
/**
* Serializes a message into cluster data
* @param msg ClusterMessage
- * @param compress boolean
- * @return
- * @throws IOException
*/
public static byte[] serialize(Serializable msg) throws IOException {
ByteArrayOutputStream outs = new ByteArrayOutputStream();
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/MemberImpl.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/MemberImpl.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
---
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/MemberImpl.java
(original)
+++
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/MemberImpl.java
Mon Jan 27 18:19:12 2014
@@ -118,8 +118,6 @@ public class MemberImpl implements Membe
/**
* Construct a new member object
- * @param name - the name of this member, cluster unique
- * @param domain - the cluster domain name of this member
* @param host - the tcp listen host
* @param port - the tcp listen port
*/
Modified:
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/Membership.java
URL:
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/Membership.java?rev=1561773&r1=1561772&r2=1561773&view=diff
==============================================================================
---
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/Membership.java
(original)
+++
tomcat/tc6.0.x/trunk/java/org/apache/catalina/tribes/membership/Membership.java
Mon Jan 27 18:19:12 2014
@@ -75,7 +75,6 @@ public class Membership
/**
* Constructs a new membership
- * @param name - has to be the name of the local member. Used to filter
the local member from the cluster membership
*/
public Membership(MemberImpl local, boolean includeLocal) {
this.local = local;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
