From 5d02c8e3ae44aad4f6bbbe4a169bbb9b18acf83b Mon Sep 17 00:00:00 2001 From: Jon Skeet Date: Wed, 27 Mar 2002 10:21:31 +0000 Subject: [PATCH] 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... git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272051 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/tools/ant/filters/StringInputStream.java | 1 - .../apache/tools/ant/filters/util/ChainReaderHelper.java | 1 - src/main/org/apache/tools/ant/taskdefs/Manifest.java | 4 ++-- .../org/apache/tools/ant/taskdefs/optional/jsp/JspC.java | 7 ++++--- .../tools/ant/taskdefs/optional/jsp/JspNameMangler.java | 6 +++--- .../apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java | 2 +- .../tools/ant/taskdefs/optional/vss/MSVSSCREATE.java | 2 +- src/main/org/apache/tools/ant/types/XMLCatalog.java | 2 +- src/main/org/apache/tools/ant/util/LoaderUtils.java | 1 - .../org/apache/tools/ant/util/depend/AbstractAnalyzer.java | 1 - .../apache/tools/ant/util/depend/DependencyAnalyzer.java | 1 - .../tools/ant/util/depend/bcel/AncestorAnalyzer.java | 1 - .../tools/ant/util/depend/bcel/DependencyVisitor.java | 4 ++-- .../apache/tools/ant/util/depend/bcel/FullAnalyzer.java | 1 - 14 files changed, 14 insertions(+), 20 deletions(-) diff --git a/src/main/org/apache/tools/ant/filters/StringInputStream.java b/src/main/org/apache/tools/ant/filters/StringInputStream.java index abfc50491..958979f64 100644 --- a/src/main/org/apache/tools/ant/filters/StringInputStream.java +++ b/src/main/org/apache/tools/ant/filters/StringInputStream.java @@ -61,7 +61,6 @@ import java.io.StringReader; * Wrap a String as an InputStream * * @author Magesh Umasankar - * @created 20 February 2002 */ public class StringInputStream extends InputStream diff --git a/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java b/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java index 384ba17b6..25227aeab 100644 --- a/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java +++ b/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java @@ -74,7 +74,6 @@ import java.util.Vector; * Process a FilterReader chain. * * @author Magesh Umasankar - * @created 23 February 2002 */ public final class ChainReaderHelper { diff --git a/src/main/org/apache/tools/ant/taskdefs/Manifest.java b/src/main/org/apache/tools/ant/taskdefs/Manifest.java index 2a85d3653..d58ca9de5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Manifest.java +++ b/src/main/org/apache/tools/ant/taskdefs/Manifest.java @@ -107,8 +107,8 @@ public class Manifest extends Task { 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; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java index f11d57965..580a6b876 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java @@ -330,7 +330,7 @@ public class JspC extends MatchingTask } /** - * 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 @@ public class JspC extends MatchingTask } /** - * 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 @@ public class JspC extends MatchingTask } /** - * test for compilation needed. true means yes, false means + * Test whether or not compilation is needed. A return value of + * true means yes, false 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 diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java index e217d6efd..7e03ca314 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java @@ -56,12 +56,12 @@ import java.io.File; 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 { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java index 07ad9ce59..237bd7852 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java @@ -184,7 +184,7 @@ public class MSVSSADD extends MSVSS { } /** - * Set the comment to apply in SourceSafe + * Sets the comment to apply in SourceSafe. *

* If this is null or empty, it will be replaced with "-" which * is what SourceSafe uses for an empty comment. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java index b1efb0843..e877fe8ab 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java @@ -171,7 +171,7 @@ public class MSVSSCREATE extends MSVSS { } /** - * Set the comment to apply in SourceSafe + * Sets the comment to apply in SourceSafe. *

* If this is null or empty, it will be replaced with "-" which * is what SourceSafe uses for an empty comment. diff --git a/src/main/org/apache/tools/ant/types/XMLCatalog.java b/src/main/org/apache/tools/ant/types/XMLCatalog.java index 55912012d..b4723606f 100644 --- a/src/main/org/apache/tools/ant/types/XMLCatalog.java +++ b/src/main/org/apache/tools/ant/types/XMLCatalog.java @@ -70,7 +70,7 @@ import org.apache.tools.ant.util.LoaderUtils; 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. *

* * <catalog>
diff --git a/src/main/org/apache/tools/ant/util/LoaderUtils.java b/src/main/org/apache/tools/ant/util/LoaderUtils.java index f49e67823..042e60ee6 100644 --- a/src/main/org/apache/tools/ant/util/LoaderUtils.java +++ b/src/main/org/apache/tools/ant/util/LoaderUtils.java @@ -62,7 +62,6 @@ import org.apache.tools.ant.BuildException; * ClassLoader utility methods * * @author Conor MacNeill - * @created 11 March 2002 */ public class LoaderUtils { /** The getContextClassLoader method */ diff --git a/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java index 30c523a40..94dcbd93f 100644 --- a/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java @@ -64,7 +64,6 @@ import org.apache.tools.ant.types.Path; * 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. */ diff --git a/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java index 407484cdb..3217d8d34 100644 --- a/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java @@ -68,7 +68,6 @@ import org.apache.tools.ant.types.Path; * generic configure method * * @author Conor MacNeill - * @created 13 March 2002 */ public interface DependencyAnalyzer { /** diff --git a/src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java index cb1042815..181456b73 100644 --- a/src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java @@ -66,7 +66,6 @@ import org.apache.tools.ant.util.depend.AbstractAnalyzer; * dependencies. * * @author Conor MacNeill - * @created 13 March 2002 */ public class AncestorAnalyzer extends AbstractAnalyzer { /** diff --git a/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java b/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java index 56e8ef25f..2c6c3e8b7 100644 --- a/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java +++ b/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java @@ -68,7 +68,6 @@ import org.apache.bcel.classfile.Method; * * @author Conor MacNeill * @author Holger Engels - * @created 15 March 2002 */ public class DependencyVisitor extends EmptyVisitor { /** The collectd dependencies */ @@ -171,7 +170,8 @@ public class DependencyVisitor extends EmptyVisitor { } /** - * 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 */ diff --git a/src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java index c3af956ca..4f9786fcd 100644 --- a/src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java @@ -67,7 +67,6 @@ import org.apache.tools.ant.util.depend.AbstractAnalyzer; * * @author Conor MacNeill * @author Holger Engels - * @created 13 March 2002 */ public class FullAnalyzer extends AbstractAnalyzer { /**