Browse Source

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
master
Jon Skeet 23 years ago
parent
commit
5d02c8e3ae
14 changed files with 14 additions and 20 deletions
  1. +0
    -1
      src/main/org/apache/tools/ant/filters/StringInputStream.java
  2. +0
    -1
      src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java
  3. +2
    -2
      src/main/org/apache/tools/ant/taskdefs/Manifest.java
  4. +4
    -3
      src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
  5. +3
    -3
      src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java
  6. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java
  7. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java
  8. +1
    -1
      src/main/org/apache/tools/ant/types/XMLCatalog.java
  9. +0
    -1
      src/main/org/apache/tools/ant/util/LoaderUtils.java
  10. +0
    -1
      src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java
  11. +0
    -1
      src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java
  12. +0
    -1
      src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java
  13. +2
    -2
      src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java
  14. +0
    -1
      src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java

+ 0
- 1
src/main/org/apache/tools/ant/filters/StringInputStream.java View File

@@ -61,7 +61,6 @@ import java.io.StringReader;
* Wrap a String as an InputStream * Wrap a String as an InputStream
* *
* @author <a href="mailto:umagesh@apache.org">Magesh Umasankar</a> * @author <a href="mailto:umagesh@apache.org">Magesh Umasankar</a>
* @created 20 February 2002
*/ */
public class StringInputStream public class StringInputStream
extends InputStream extends InputStream


+ 0
- 1
src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java View File

@@ -74,7 +74,6 @@ import java.util.Vector;
* Process a FilterReader chain. * Process a FilterReader chain.
* *
* @author <a href="mailto:umagesh@apache.org">Magesh Umasankar</a> * @author <a href="mailto:umagesh@apache.org">Magesh Umasankar</a>
* @created 23 February 2002
*/ */
public final class ChainReaderHelper { public final class ChainReaderHelper {




+ 2
- 2
src/main/org/apache/tools/ant/taskdefs/Manifest.java View File

@@ -107,8 +107,8 @@ public class Manifest extends Task {
public static final int MAX_LINE_LENGTH = 72; 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; public static final int MAX_SECTION_LENGTH = MAX_LINE_LENGTH - 2;




+ 4
- 3
src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java View File

@@ -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 * @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) { public void setCompiler(String compiler) {
this.compilerName=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
* <code>true<code> means yes, <code>false</code> means
* our tests do not indicate this, but as the TLDs are * our tests do not indicate this, but as the TLDs are
* not used for dependency checking this is not guaranteed. * not used for dependency checking this is not guaranteed.
* The current tests are * The current tests are


+ 3
- 3
src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.java View File

@@ -56,12 +56,12 @@ import java.io.File;
import java.io.IOException; 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 Steve Loughran
* @author Danno Ferrin * @author Danno Ferrin
* @see org.apache.jasper.compiler.CommandLineCompiler;
*/ */
public class JspNameMangler implements JspMangler { public class JspNameMangler implements JspMangler {




+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java View File

@@ -184,7 +184,7 @@ public class MSVSSADD extends MSVSS {
} }


/** /**
* Set the comment to apply in SourceSafe
* Sets the comment to apply in SourceSafe.
* <p> * <p>
* If this is null or empty, it will be replaced with "-" which * If this is null or empty, it will be replaced with "-" which
* is what SourceSafe uses for an empty comment. * is what SourceSafe uses for an empty comment.


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java View File

@@ -171,7 +171,7 @@ public class MSVSSCREATE extends MSVSS {
} }


/** /**
* Set the comment to apply in SourceSafe
* Sets the comment to apply in SourceSafe.
* <p> * <p>
* If this is null or empty, it will be replaced with "-" which * If this is null or empty, it will be replaced with "-" which
* is what SourceSafe uses for an empty comment. * is what SourceSafe uses for an empty comment.


+ 1
- 1
src/main/org/apache/tools/ant/types/XMLCatalog.java View File

@@ -70,7 +70,7 @@ import org.apache.tools.ant.util.LoaderUtils;
import org.apache.tools.ant.util.FileUtils; 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> * <p>
* <code> * <code>
* &lt;catalog&gt;<br> * &lt;catalog&gt;<br>


+ 0
- 1
src/main/org/apache/tools/ant/util/LoaderUtils.java View File

@@ -62,7 +62,6 @@ import org.apache.tools.ant.BuildException;
* ClassLoader utility methods * ClassLoader utility methods
* *
* @author Conor MacNeill * @author Conor MacNeill
* @created 11 March 2002
*/ */
public class LoaderUtils { public class LoaderUtils {
/** The getContextClassLoader method */ /** The getContextClassLoader method */


+ 0
- 1
src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java View File

@@ -64,7 +64,6 @@ import org.apache.tools.ant.types.Path;
* for the bulk of interface methods. * for the bulk of interface methods.
* *
* @author Conor MacNeill * @author Conor MacNeill
* @created 13 March 2002
*/ */
public abstract class AbstractAnalyzer implements DependencyAnalyzer { public abstract class AbstractAnalyzer implements DependencyAnalyzer {
/** Maximum number of loops for looking for indirect dependencies. */ /** Maximum number of loops for looking for indirect dependencies. */


+ 0
- 1
src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java View File

@@ -68,7 +68,6 @@ import org.apache.tools.ant.types.Path;
* generic configure method * generic configure method
* *
* @author Conor MacNeill * @author Conor MacNeill
* @created 13 March 2002
*/ */
public interface DependencyAnalyzer { public interface DependencyAnalyzer {
/** /**


+ 0
- 1
src/main/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.java View File

@@ -66,7 +66,6 @@ import org.apache.tools.ant.util.depend.AbstractAnalyzer;
* dependencies. * dependencies.
* *
* @author Conor MacNeill * @author Conor MacNeill
* @created 13 March 2002
*/ */
public class AncestorAnalyzer extends AbstractAnalyzer { public class AncestorAnalyzer extends AbstractAnalyzer {
/** /**


+ 2
- 2
src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java View File

@@ -68,7 +68,6 @@ import org.apache.bcel.classfile.Method;
* *
* @author Conor MacNeill * @author Conor MacNeill
* @author <a href="mailto:hengels@innovidata.com">Holger Engels</a> * @author <a href="mailto:hengels@innovidata.com">Holger Engels</a>
* @created 15 March 2002
*/ */
public class DependencyVisitor extends EmptyVisitor { public class DependencyVisitor extends EmptyVisitor {
/** The collectd dependencies */ /** 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 * @param classname the class name in slash format
*/ */


+ 0
- 1
src/main/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.java View File

@@ -67,7 +67,6 @@ import org.apache.tools.ant.util.depend.AbstractAnalyzer;
* *
* @author Conor MacNeill * @author Conor MacNeill
* @author <a href="mailto:hengels@innovidata.com">Holger Engels</a> * @author <a href="mailto:hengels@innovidata.com">Holger Engels</a>
* @created 13 March 2002
*/ */
public class FullAnalyzer extends AbstractAnalyzer { public class FullAnalyzer extends AbstractAnalyzer {
/** /**


Loading…
Cancel
Save