jskeet 02/03/27 02:21:31
Modified: src/main/org/apache/tools/ant/util/depend/bcel
DependencyVisitor.java AncestorAnalyzer.java
FullAnalyzer.java
src/main/org/apache/tools/ant/taskdefs/optional/vss
MSVSSCREATE.java MSVSSADD.java
src/main/org/apache/tools/ant/util LoaderUtils.java
src/main/org/apache/tools/ant/filters/util
ChainReaderHelper.java
src/main/org/apache/tools/ant/taskdefs/optional/jsp
JspC.java JspNameMangler.java
src/main/org/apache/tools/ant/filters StringInputStream.java
src/main/org/apache/tools/ant/util/depend
AbstractAnalyzer.java DependencyAnalyzer.java
src/main/org/apache/tools/ant/taskdefs Manifest.java
src/main/org/apache/tools/ant/types XMLCatalog.java
Log:
Fixed up JavaDocs so they build without errors. The main changes were:
o Capitalisation. Please capitalise the first word of a new sentence,
otherwise break-iterator complains.
o @created tags. These aren't valid JavaDoc, and the info is in CVS anyway...
Revision Changes Path
1.3 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java
Index: DependencyVisitor.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DependencyVisitor.java 18 Mar 2002 02:44:30 -0000 1.2
+++ DependencyVisitor.java 27 Mar 2002 10:21:30 -0000 1.3
@@ -68,7 +68,6 @@
*
* @author Conor MacNeill
* @author <a href="mailto:[EMAIL PROTECTED]">Holger Engels</a>
- * @created 15 March 2002
*/
public class DependencyVisitor extends EmptyVisitor {
/** The collectd dependencies */
@@ -171,7 +170,8 @@
}
/**
- * Add a class name in slash format (e.g. org/apache/tools/ant/...)
+ * Adds a class name in slash format
+ * (for example org/apache/tools/ant/Main).
*
* @param classname the class name in slash format
*/
1.3 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java
Index: AncestorAnalyzer.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AncestorAnalyzer.java 18 Mar 2002 02:44:30 -0000 1.2
+++ AncestorAnalyzer.java 27 Mar 2002 10:21:30 -0000 1.3
@@ -66,7 +66,6 @@
* dependencies.
*
* @author Conor MacNeill
- * @created 13 March 2002
*/
public class AncestorAnalyzer extends AbstractAnalyzer {
/**
1.3 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java
Index: FullAnalyzer.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- FullAnalyzer.java 18 Mar 2002 02:44:30 -0000 1.2
+++ FullAnalyzer.java 27 Mar 2002 10:21:30 -0000 1.3
@@ -67,7 +67,6 @@
*
* @author Conor MacNeill
* @author <a href="mailto:[EMAIL PROTECTED]">Holger Engels</a>
- * @created 13 March 2002
*/
public class FullAnalyzer extends AbstractAnalyzer {
/**
1.2 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
Index: MSVSSCREATE.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MSVSSCREATE.java 21 Mar 2002 08:48:18 -0000 1.1
+++ MSVSSCREATE.java 27 Mar 2002 10:21:30 -0000 1.2
@@ -171,7 +171,7 @@
}
/**
- * Set the comment to apply in SourceSafe
+ * Sets the comment to apply in SourceSafe.
* <p>
* If this is null or empty, it will be replaced with "-" which
* is what SourceSafe uses for an empty comment.
1.2 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
Index: MSVSSADD.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MSVSSADD.java 21 Mar 2002 08:33:56 -0000 1.1
+++ MSVSSADD.java 27 Mar 2002 10:21:30 -0000 1.2
@@ -184,7 +184,7 @@
}
/**
- * Set the comment to apply in SourceSafe
+ * Sets the comment to apply in SourceSafe.
* <p>
* If this is null or empty, it will be replaced with "-" which
* is what SourceSafe uses for an empty comment.
1.3 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/util/LoaderUtils.java
Index: LoaderUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/LoaderUtils.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LoaderUtils.java 18 Mar 2002 02:44:30 -0000 1.2
+++ LoaderUtils.java 27 Mar 2002 10:21:30 -0000 1.3
@@ -62,7 +62,6 @@
* ClassLoader utility methods
*
* @author Conor MacNeill
- * @created 11 March 2002
*/
public class LoaderUtils {
/** The getContextClassLoader method */
1.2 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java
Index: ChainReaderHelper.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ChainReaderHelper.java 6 Mar 2002 03:25:50 -0000 1.1
+++ ChainReaderHelper.java 27 Mar 2002 10:21:30 -0000 1.2
@@ -74,7 +74,6 @@
* Process a FilterReader chain.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Magesh Umasankar</a>
- * @created 23 February 2002
*/
public final class ChainReaderHelper {
1.12 +4 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
Index: JspC.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- JspC.java 14 Mar 2002 07:19:59 -0000 1.11
+++ JspC.java 27 Mar 2002 10:21:30 -0000 1.12
@@ -330,7 +330,7 @@
}
/**
- * web apps param. only one is allowed.
+ * Web apps parameter. Only one is allowed.
*
* @param fs add a web app fileset
*/
@@ -350,7 +350,7 @@
}
/**
- * set the compiler. optional: default=jasper
+ * Sets the compiler to use. Optional: default=jasper
*/
public void setCompiler(String compiler) {
this.compilerName=compiler;
@@ -512,7 +512,8 @@
}
/**
- * test for compilation needed. true means yes, false means
+ * Test whether or not compilation is needed. A return value of
+ * <code>true<code> means yes, <code>false</code> means
* our tests do not indicate this, but as the TLDs are
* not used for dependency checking this is not guaranteed.
* The current tests are
1.3 +3 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java
Index: JspNameMangler.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JspNameMangler.java 14 Mar 2002 07:19:59 -0000 1.2
+++ JspNameMangler.java 27 Mar 2002 10:21:30 -0000 1.3
@@ -56,12 +56,12 @@
import java.io.IOException;
/**
- * this is a class derived from the Jasper code to map from a JSP filename
- * to a valid java classname.
+ * This is a class derived from the Jasper code
+ * (org.apache.jasper.compiler.CommandLineCompiler) to map from a JSP
filename
+ * to a valid Java classname.
*
* @author Steve Loughran
* @author Danno Ferrin
- * @see org.apache.jasper.compiler.CommandLineCompiler;
*/
public class JspNameMangler implements JspMangler {
1.2 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/filters/StringInputStream.java
Index: StringInputStream.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/filters/StringInputStream.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StringInputStream.java 6 Mar 2002 03:25:50 -0000 1.1
+++ StringInputStream.java 27 Mar 2002 10:21:30 -0000 1.2
@@ -61,7 +61,6 @@
* Wrap a String as an InputStream
*
* @author <a href="mailto:[EMAIL PROTECTED]">Magesh Umasankar</a>
- * @created 20 February 2002
*/
public class StringInputStream
extends InputStream
1.5 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java
Index: AbstractAnalyzer.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AbstractAnalyzer.java 21 Mar 2002 11:34:21 -0000 1.4
+++ AbstractAnalyzer.java 27 Mar 2002 10:21:31 -0000 1.5
@@ -64,7 +64,6 @@
* for the bulk of interface methods.
*
* @author Conor MacNeill
- * @created 13 March 2002
*/
public abstract class AbstractAnalyzer implements DependencyAnalyzer {
/** Maximum number of loops for looking for indirect dependencies. */
1.4 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java
Index: DependencyAnalyzer.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DependencyAnalyzer.java 21 Mar 2002 11:12:19 -0000 1.3
+++ DependencyAnalyzer.java 27 Mar 2002 10:21:31 -0000 1.4
@@ -68,7 +68,6 @@
* generic configure method
*
* @author Conor MacNeill
- * @created 13 March 2002
*/
public interface DependencyAnalyzer {
/**
1.28 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Manifest.java
Index: Manifest.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Manifest.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- Manifest.java 21 Mar 2002 11:00:30 -0000 1.27
+++ Manifest.java 27 Mar 2002 10:21:31 -0000 1.28
@@ -107,8 +107,8 @@
public static final int MAX_LINE_LENGTH = 72;
/**
- * Max length of a line section which is continued. need to allow
- * for the CRLF
+ * Max length of a line section which is continued. Need to allow
+ * for the CRLF.
*/
public static final int MAX_SECTION_LENGTH = MAX_LINE_LENGTH - 2;
1.4 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/types/XMLCatalog.java
Index: XMLCatalog.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/XMLCatalog.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XMLCatalog.java 11 Mar 2002 13:01:05 -0000 1.3
+++ XMLCatalog.java 27 Mar 2002 10:21:31 -0000 1.4
@@ -70,7 +70,7 @@
import org.apache.tools.ant.util.FileUtils;
/**
- * This data type provides a catalog of DTD locations
+ * This data type provides a catalog of DTD locations.
* <p>
* <code>
* <catalog><br>
@@ -91,7 +91,7 @@
* elements, or use Norman Walsh's entity resolver from xml-commons</p>
*
* @author dIon Gillard
- * @version $Id: XMLCatalog.java,v 1.3 2002/03/11 13:01:05 conor Exp $
+ * @version $Id: XMLCatalog.java,v 1.4 2002/03/27 10:21:31 jskeet Exp $
*/
public class XMLCatalog extends DataType implements Cloneable,
EntityResolver {
/** File utilities instance */
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
