Author: markt
Date: Sat Jan 16 15:16:21 2016
New Revision: 1724988
URL: http://svn.apache.org/viewvc?rev=1724988&view=rev
Log:
Javadoc
Modified:
tomcat/trunk/java/org/apache/catalina/ssi/ExpressionParseTree.java
tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java
tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java
tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java
Modified: tomcat/trunk/java/org/apache/catalina/ssi/ExpressionParseTree.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ssi/ExpressionParseTree.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/ssi/ExpressionParseTree.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/ssi/ExpressionParseTree.java Sat Jan
16 15:16:21 2016
@@ -211,7 +211,7 @@ public class ExpressionParseTree {
*/
private abstract class Node {
/**
- * Return true if the node evaluates to true.
+ * @return {@code true} if the node evaluates to true.
*/
public abstract boolean evaluate();
}
@@ -230,6 +230,8 @@ public class ExpressionParseTree {
/**
* Resolves any variable references and returns the value string.
+ *
+ * @return the value string
*/
public String getValue() {
if (resolved == null)
@@ -272,7 +274,7 @@ public class ExpressionParseTree {
/**
- * Returns a preference level suitable for comparison to other OppNode
+ * @return a precedence level suitable for comparison to other OppNode
* preference levels.
*/
public abstract int getPrecedence();
@@ -281,6 +283,8 @@ public class ExpressionParseTree {
/**
* Lets the node pop its own branch nodes off the front of the
* specified list. The default pulls two.
+ *
+ * @param values The list from which to pop the values
*/
public void popValues(List<Node> values) {
right = values.remove(0);
Modified: tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java Sat
Jan 16 15:16:21 2016
@@ -52,6 +52,8 @@ import org.apache.tomcat.util.scan.JarFa
* <p>
* Provider classes will be loaded using the context's ClassLoader.
*
+ * @param <T> The type of service to load
+ *
* @see javax.servlet.ServletContainerInitializer
* @see java.util.ServiceLoader
*/
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
Sat Jan 16 15:16:21 2016
@@ -47,8 +47,8 @@ import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
/**
- *
- * @version 1.0
+ * @param <K> The type of Key
+ * @param <V> The type of Value
*/
public abstract class AbstractReplicatedMap<K,V>
implements Map<K,V>, Serializable, RpcCallback, ChannelListener,
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
Sat Jan 16 15:16:21 2016
@@ -60,7 +60,9 @@ import org.apache.juli.logging.LogFactor
* <br><br><b>REMBER TO CALL</b> <code>breakdown()</code> or
<code>finalize()</code> when you are done with the map to
* avoid memory leaks.<br><br>
* TODO implement periodic sync/transfer thread
- * @version 1.0
+ *
+ * @param <K> The type of Key
+ * @param <V> The type of Value
*/
public class LazyReplicatedMap<K,V> extends AbstractReplicatedMap<K,V> {
private static final long serialVersionUID = 1L;
Modified: tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java Sat
Jan 16 15:16:21 2016
@@ -51,7 +51,8 @@ import org.apache.juli.logging.LogFactor
* TODO memberDisappeared, should do nothing except change map membership
* by default it relocates the primary objects
*
- * @version 1.0
+ * @param <K> The type of Key
+ * @param <V> The type of Value
*/
public class ReplicatedMap<K,V> extends AbstractReplicatedMap<K,V> {
Modified: tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java Sat Jan 16
15:16:21 2016
@@ -28,6 +28,9 @@ import org.apache.tomcat.util.res.String
* to clone them in order to avoid modifications. When first created, a
* <code>ParmaeterMap</code> instance is not locked.
*
+ * @param <K> The type of Key
+ * @param <V> The type of Value
+ *
* @author Craig R. McClanahan
*/
public final class ParameterMap<K,V> extends LinkedHashMap<K,V> {
Modified: tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java Sat Jan 16
15:16:21 2016
@@ -32,6 +32,8 @@ import org.apache.tomcat.util.res.String
* to avoid modifications. When first created, a <code>ResourceMap</code>
* is not locked.
*
+ * @param <T> The type of elements in the Set
+ *
* @author Craig R. McClanahan
*/
public final class ResourceSet<T> extends HashSet<T> {
Modified: tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java?rev=1724988&r1=1724987&r2=1724988&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java Sat Jan 16
15:16:21 2016
@@ -76,7 +76,9 @@ public class XMLWriter {
/**
* New XML writer utility that will store its data in an internal buffer
* and can write it to the specified writer.
- * @see sendData
+ * <p>
+ * See {@link #sendData()}
+ *
* @param writer The writer to use
*/
public XMLWriter(Writer writer) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
