From afdc184c8f303da9da01ffd04df44737aaa83bde Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Tue, 6 Nov 2001 11:08:34 +0000 Subject: [PATCH] get rid of javadoc warnings git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269878 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/tools/ant/TaskAdapter.java | 2 +- .../tools/ant/taskdefs/XSLTLiaison.java | 2 +- .../ant/taskdefs/optional/ReplaceRegExp.java | 25 +++++++------------ .../taskdefs/optional/XMLValidateTask.java | 8 +++--- .../tools/ant/types/RegularExpression.java | 12 ++++----- .../apache/tools/ant/types/Substitution.java | 5 ++-- 6 files changed, 23 insertions(+), 31 deletions(-) diff --git a/src/main/org/apache/tools/ant/TaskAdapter.java b/src/main/org/apache/tools/ant/TaskAdapter.java index 156b4da18..6bb719dbc 100644 --- a/src/main/org/apache/tools/ant/TaskAdapter.java +++ b/src/main/org/apache/tools/ant/TaskAdapter.java @@ -73,7 +73,7 @@ public class TaskAdapter extends Task { * * Checks conditions only, which are additionally required for a tasks * adapted by TaskAdapter. Thus, this method should be called by - * {@link Project.checkTaskClass}. + * {@link Project#checkTaskClass}. * * Throws a BuildException and logs as Project.MSG_ERR for * conditions, that will cause the task execution to fail. diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java index 231b82e23..da364af93 100644 --- a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java +++ b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java @@ -61,7 +61,7 @@ import java.io.File; * * @author Sam Ruby * @author Stephane Bailliez - * @see #XSLTProcess + * @see XSLTProcess */ public interface XSLTLiaison { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java index bcdfb6c3a..140bce798 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java @@ -86,24 +86,20 @@ import java.util.Vector; * requires the Jakarta Oro Package). * * 
- * For jdk  <= 1.3, there are two available implementations:
+ * For jdk  <= 1.3, there are two available implementations:
  *   org.apache.tools.ant.util.regexp.JakartaOroRegexp (the default)
  *        Requires  the jakarta-oro package
  *
  *   org.apache.tools.ant.util.regexp.JakartaRegexpRegexp
  *        Requires the jakarta-regexp package
  *
- * For jdk <= 1.4, and additional implementation is available:
+ * For jdk >= 1.4 an additional implementation is available:
  *   org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp
  *        Requires the jdk 1.4 built in regular expression package.
  *
* * Usage: * - * Task declaration in the project: - * - * <taskdef name="replaceregexp" class="com.sedona.ant.taskdef.ReplaceRegExp" /> - * * Call Syntax: * * <replaceregexp file="file" @@ -124,14 +120,14 @@ import java.util.Vector; * * Attributes: * - * file --> A single file to operation on (mutually exclusive with the fileset subelements) - * match --> The Perl5 Regular expression to match (see perl5 documentation) - * replace --> The Perl5 Expression replacement string (see perl5 documentation) - * flags --> The Perl5 options to give to the replacement (see perl5 documentation for full list) + * file --> A single file to operation on (mutually exclusive with the fileset subelements) + * match --> The Regular expression to match + * replace --> The Expression replacement string + * flags --> The options to give to the replacement * g = Substitute all occurrences. default is to replace only the first one * i = Case insensitive match * - * byline --> Should this file be processed a single line at a time (default is false) + * byline --> Should this file be processed a single line at a time (default is false) * "true" indicates to perform replacement on a line by line basis * "false" indicates to perform replacement on the whole file at once. * @@ -139,12 +135,11 @@ import java.util.Vector; * * The following call could be used to replace an old property name in a ".properties" * file with a new name. In the replace attribute, you can refer to any part of the - * match expression in parenthesis using the syntax appropriate for the specified - * implementation ('$$1' for org.apache.tools.ant.util.regexp.JakartaOroRegexp). + * match expression in parenthesis using backslash followed by a number like '\1'. * * <replaceregexp file="test.properties" * match="MyProperty=(.*)" - * replace="NewProperty=$$1" + * replace="NewProperty=\1" * byline="true" /> * * @@ -153,8 +148,6 @@ import java.util.Vector; */ public class ReplaceRegExp extends Task { - // Don't extend SedonaTaskContainer until we can delay building of - // the subtasks so variable of the current token works. private File file; private String flags; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java index f2d83d9dd..ffaca7f80 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java @@ -167,8 +167,8 @@ public class XMLValidateTask extends Task { *

if className is an implementation of org.xml.sax.Parser, {@link #setLenient(boolean)}, * will be ignored. *

if not set, the default {@link #DEFAULT_XML_READER_CLASSNAME} will be used. - * @see org.xml.sax.XMLReader; - * @see org.xml.sax.Parser; + * @see org.xml.sax.XMLReader + * @see org.xml.sax.Parser */ public void setClassName(String className) { @@ -189,7 +189,7 @@ public class XMLValidateTask extends Task { } /** - * @see #setClassPath + * @see #setClasspath */ public Path createClasspath() { if (this.classpath == null) { @@ -199,7 +199,7 @@ public class XMLValidateTask extends Task { } /** - * @see #setClassPath + * @see #setClasspath */ public void setClasspathRef(Reference r) { createClasspath().setRefid(r); diff --git a/src/main/org/apache/tools/ant/types/RegularExpression.java b/src/main/org/apache/tools/ant/types/RegularExpression.java index d38609ee7..bb9fb8738 100644 --- a/src/main/org/apache/tools/ant/types/RegularExpression.java +++ b/src/main/org/apache/tools/ant/types/RegularExpression.java @@ -70,27 +70,27 @@ import org.apache.tools.ant.util.regexp.RegexpFactory; * that will be used. * * 

- * For jdk  <= 1.3, there are two available implementations:
+ * For jdk  <= 1.3, there are two available implementations:
  *   org.apache.tools.ant.util.regexp.JakartaOroRegexp (the default)
  *        Based on the jakarta-oro package
  *
  *   org.apache.tools.ant.util.regexp.JakartaRegexpRegexp
  *        Based on the jakarta-regexp package
  *
- * For jdk <= 1.4, and additional implementation is available:
+ * For jdk >= 1.4 an additional implementation is available:
  *   org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp
  *        Based on the jdk 1.4 built in regular expression package.
  *
* - * @see org.apache.oro.regex.Perl5Compiler - * @see org.apache.regexp.RE - * @see java.util.regex.Pattern - * * 
  *   <regularexpression [ [id="id"] pattern="expression" | refid="id" ] 
  *   />
  *
* + * @see org.apache.oro.regex.Perl5Compiler + * @see org.apache.regexp.RE + * @see java.util.regex.Pattern + * * @see org.apache.tools.ant.util.regexp.Regexp * @author Matthew Inger mattinger@mindless.com */ diff --git a/src/main/org/apache/tools/ant/types/Substitution.java b/src/main/org/apache/tools/ant/types/Substitution.java index 1e3bdcf25..92fbbaa5e 100644 --- a/src/main/org/apache/tools/ant/types/Substitution.java +++ b/src/main/org/apache/tools/ant/types/Substitution.java @@ -61,15 +61,14 @@ import org.apache.tools.ant.types.DataType; /*** * A regular expression substitution datatype. It is an expression - * that is meant to replace a regular expression. The syntax is the - * same as Perl5. - * @see org.apache.oro.text.regex.Perl5Substitition + * that is meant to replace a regular expression. * * 
  *   <substitition [ [id="id"] expression="expression" | refid="id" ] 
  *   />
  *
* + * @see org.apache.oro.text.regex.Perl5Substitition * @author Matthew Inger mattinger@mindless.com */ public class Substitution extends DataType