Browse Source

get rid of javadoc warnings

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269878 13f79535-47bb-0310-9956-ffa450edef68
master
Stefan Bodewig 23 years ago
parent
commit
afdc184c8f
6 changed files with 23 additions and 31 deletions
  1. +1
    -1
      src/main/org/apache/tools/ant/TaskAdapter.java
  2. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java
  3. +9
    -16
      src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java
  4. +4
    -4
      src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
  5. +6
    -6
      src/main/org/apache/tools/ant/types/RegularExpression.java
  6. +2
    -3
      src/main/org/apache/tools/ant/types/Substitution.java

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

@@ -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.


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/XSLTLiaison.java View File

@@ -61,7 +61,7 @@ import java.io.File;
*
* @author <a href="mailto:rubys@us.ibm.com">Sam Ruby</a>
* @author <a href="mailto:sbailliez@apache.org">Stephane Bailliez</a>
* @see #XSLTProcess
* @see XSLTProcess
*/
public interface XSLTLiaison {



+ 9
- 16
src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java View File

@@ -86,24 +86,20 @@ import java.util.Vector;
* requires the Jakarta Oro Package).
*
* <pre>
* For jdk <= 1.3, there are two available implementations:
* For jdk &lt;= 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 &gt;= 1.4 an additional implementation is available:
* org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp
* Requires the jdk 1.4 built in regular expression package.
* </pre>
*
* Usage:
*
* Task declaration in the project:
*
* &lt;taskdef name="replaceregexp" class="com.sedona.ant.taskdef.ReplaceRegExp" /&gt;
*
* Call Syntax:
*
* &lt;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 --&gt; A single file to operation on (mutually exclusive with the fileset subelements)
* match --&gt; The Regular expression to match
* replace --&gt; The Expression replacement string
* flags --&gt; 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 --&gt; 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'.
*
* &lt;replaceregexp file="test.properties"
* match="MyProperty=(.*)"
* replace="NewProperty=$$1"
* replace="NewProperty=\1"
* byline="true" /&gt;
*
* </pre>
@@ -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;


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

@@ -167,8 +167,8 @@ public class XMLValidateTask extends Task {
* <p> if className is an implementation of <code>org.xml.sax.Parser</code>, {@link #setLenient(boolean)},
* will be ignored.
* <p> 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);


+ 6
- 6
src/main/org/apache/tools/ant/types/RegularExpression.java View File

@@ -70,27 +70,27 @@ import org.apache.tools.ant.util.regexp.RegexpFactory;
* that will be used.
*
* <pre>
* For jdk <= 1.3, there are two available implementations:
* For jdk &lt;= 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 &gt;= 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.
* </pre>
*
* @see org.apache.oro.regex.Perl5Compiler
* @see org.apache.regexp.RE
* @see java.util.regex.Pattern
*
* <pre>
* &lt;regularexpression [ [id="id"] pattern="expression" | refid="id" ]
* /&gt;
* </pre>
*
* @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 <a href="mailto:mattinger@mindless.com">mattinger@mindless.com</a>
*/


+ 2
- 3
src/main/org/apache/tools/ant/types/Substitution.java View File

@@ -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.
*
* <pre>
* &lt;substitition [ [id="id"] expression="expression" | refid="id" ]
* /&gt;
* </pre>
*
* @see org.apache.oro.text.regex.Perl5Substitition
* @author Matthew Inger <a href="mailto:mattinger@mindless.com">mattinger@mindless.com</a>
*/
public class Substitution extends DataType


Loading…
Cancel
Save