jskeet 02/02/25 07:33:20
Modified: src/main/org/apache/tools/ant/types CommandlineJava.java
FilterSet.java RegularExpression.java
Substitution.java
src/main/org/apache/tools/ant/taskdefs/optional/junit
JUnitTask.java Xalan1Executor.java
XMLResultAggregator.java
src/main/org/apache/tools/ant/taskdefs KeySubst.java
LoadFile.java
src/main/org/apache/tools/ant/listener MailLogger.java
src/main/org/apache/tools/ant/util PackageNameMapper.java
src/main/org/apache/tools/ant/util/regexp RegexpFactory.java
src/main/org/apache/tools/ant TaskContainer.java
Log:
First pass of JavaDoc work just to get rid of warnings.
When this is complete, whole source tree should JavaDoc (with 1.4)
with no warnings. (With JDK1.3.1 the 1.4-regexp stuff generates
warnings, but that's all.)
Revision Changes Path
1.29 +3 -3
jakarta-ant/src/main/org/apache/tools/ant/types/CommandlineJava.java
Index: CommandlineJava.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/CommandlineJava.java,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- CommandlineJava.java 15 Feb 2002 15:05:41 -0000 1.28
+++ CommandlineJava.java 25 Feb 2002 15:33:19 -0000 1.29
@@ -64,9 +64,9 @@
/**
* A representation of a Java command line that is nothing more
- * than a composite of 2 <tt>Commandline</tt>. 1 for the vm/options and
- * 1 for the classname/arguments. It provides specific methods for
- * a java command line.
+ * than a composite of 2 <tt>Commandline</tt>. One is used for the
+ * vm/options and one for the classname/arguments. It provides
+ * specific methods for a java command line.
*
* @author [EMAIL PROTECTED]
* @author <a href="mailto:[EMAIL PROTECTED]">Stephane Bailliez</a>
1.10 +0 -3
jakarta-ant/src/main/org/apache/tools/ant/types/FilterSet.java
Index: FilterSet.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/FilterSet.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- FilterSet.java 26 Jan 2002 20:16:22 -0000 1.9
+++ FilterSet.java 25 Feb 2002 15:33:19 -0000 1.10
@@ -75,7 +75,6 @@
* A filter set may have begintoken and endtokens defined.
*
* @author <A href="mailto:[EMAIL PROTECTED]"> Michael McCallum </A>
- * @created 14 March 2001
*/
public class FilterSet extends DataType implements Cloneable {
@@ -83,7 +82,6 @@
* Individual filter component of filterset
*
* @author Michael McCallum
- * @created 14 March 2001
*/
public static class Filter {
/** Token which will be replaced in the filter operation */
@@ -150,7 +148,6 @@
* The filtersfile nested element.
*
* @author Michael McCallum
- * @created Thursday, April 19, 2001
*/
public class FiltersFile {
1.6 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/types/RegularExpression.java
Index: RegularExpression.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/RegularExpression.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RegularExpression.java 19 Feb 2002 16:48:47 -0000 1.5
+++ RegularExpression.java 25 Feb 2002 15:33:19 -0000 1.6
@@ -87,7 +87,7 @@
* />
* </pre>
*
- * @see org.apache.oro.regex.Perl5Compiler
+ * @see org.apache.oro.text.regex.Perl5Compiler
* @see org.apache.regexp.RE
* @see java.util.regex.Pattern
*
1.5 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/types/Substitution.java
Index: Substitution.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/Substitution.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Substitution.java 8 Jan 2002 19:59:45 -0000 1.4
+++ Substitution.java 25 Feb 2002 15:33:19 -0000 1.5
@@ -68,7 +68,7 @@
* />
* </pre>
*
- * @see org.apache.oro.text.regex.Perl5Substitition
+ * @see org.apache.oro.text.regex.Perl5Substitution
* @author Matthew Inger <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
*/
public class Substitution extends DataType
1.35 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
Index: JUnitTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- JUnitTask.java 19 Feb 2002 22:34:02 -0000 1.34
+++ JUnitTask.java 25 Feb 2002 15:33:19 -0000 1.35
@@ -141,7 +141,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Gerrit Riessen</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Erik Hatcher</a>
*
- * @version $Revision: 1.34 $
+ * @version $Revision: 1.35 $
*
* @see JUnitTest
* @see BatchTest
@@ -357,7 +357,7 @@
}
/**
- * Use a completely new environment
+ * Use a completely new environment.
*
* <p>Will be ignored if we are not forking a new VM.
*
1.3 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/Xalan1Executor.java
Index: Xalan1Executor.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/Xalan1Executor.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Xalan1Executor.java 10 Jan 2002 13:59:37 -0000 1.2
+++ Xalan1Executor.java 25 Feb 2002 15:33:19 -0000 1.3
@@ -63,7 +63,7 @@
/**
* Xalan 1 executor. It will need a lot of things in the classpath:
* xerces for the serialization, xalan and bsf for the extension.
- * @todo do everything via reflection to avoid compile problems ?
+ * To-do: do everything via reflection to avoid compile problems ?
*/
public class Xalan1Executor extends XalanExecutor {
void execute() throws Exception {
1.10 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java
Index: XMLResultAggregator.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- XMLResultAggregator.java 20 Jan 2002 20:45:57 -0000 1.9
+++ XMLResultAggregator.java 25 Feb 2002 15:33:19 -0000 1.10
@@ -105,7 +105,7 @@
protected Vector transformers = new Vector();
- /** the default directory: <tt>.</tt>. It is resolved from the project
directory */
+ /** The default directory: <tt>.</tt>. It is resolved from the
project directory */
public final static String DEFAULT_DIR = ".";
/** the default file name: <tt>TESTS-TestSuites.xml</tt> */
@@ -307,8 +307,8 @@
/**
* Create a new document builder. Will issue an
<tt>ExceptionInitializerError</tt>
* if something is going wrong. It is fatal anyway.
+ * To-do: factorize this somewhere else. It is duplicated code.
* @return a new document builder to create a DOM
- * @todo factorize this somewhere else. It is duplicated code.
*/
private static DocumentBuilder getDocumentBuilder() {
try {
1.10 +3 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/KeySubst.java
Index: KeySubst.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/KeySubst.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- KeySubst.java 26 Jan 2002 19:22:05 -0000 1.9
+++ KeySubst.java 25 Feb 2002 15:33:19 -0000 1.10
@@ -140,6 +140,8 @@
this.sep = sep;
}
/**
+ * Sets the keys.
+ *
Format string is like this:
<p>
name=value*name2=value
@@ -184,7 +186,7 @@
/**
Does replacement on text using the hashtable of keys.
- @returns the string with the replacements in it.
+ @return the string with the replacements in it.
*/
public static String replace ( String origString, Hashtable keys )
throws BuildException
1.8 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/LoadFile.java
Index: LoadFile.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/LoadFile.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- LoadFile.java 2 Feb 2002 12:52:01 -0000 1.7
+++ LoadFile.java 25 Feb 2002 15:33:19 -0000 1.8
@@ -64,7 +64,6 @@
* Load a file into a property
*
* @author Steve Loughran
- * @created 10 December 2001
*/
public class LoadFile extends Task {
1.7 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/listener/MailLogger.java
Index: MailLogger.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/listener/MailLogger.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- MailLogger.java 26 Jan 2002 18:53:26 -0000 1.6
+++ MailLogger.java 25 Feb 2002 15:33:20 -0000 1.7
@@ -95,7 +95,6 @@
* file will override Ant properties.
*
[EMAIL PROTECTED] Erik Hatcher <a href="mailto:[EMAIL
PROTECTED]">[EMAIL PROTECTED]</a>
- [EMAIL PROTECTED] December 12, 2001
*/
public class MailLogger extends DefaultLogger {
1.4 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/util/PackageNameMapper.java
Index: PackageNameMapper.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/PackageNameMapper.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PackageNameMapper.java 10 Jan 2002 11:21:21 -0000 1.3
+++ PackageNameMapper.java 25 Feb 2002 15:33:20 -0000 1.4
@@ -65,7 +65,6 @@
* </pre>
*
[EMAIL PROTECTED] Erik Hatcher
- [EMAIL PROTECTED] December 29, 2001
*/
public class PackageNameMapper extends GlobPatternMapper {
/**
1.6 +5 -4
jakarta-ant/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java
Index: RegexpFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RegexpFactory.java 31 Jan 2002 09:24:16 -0000 1.5
+++ RegexpFactory.java 25 Feb 2002 15:33:20 -0000 1.6
@@ -62,7 +62,7 @@
* <code>ant.regexp.regexpimpl</code>.
*
* @author Matthew Inger <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
- * @version $Revision: 1.5 $
+ * @version $Revision: 1.6 $
*/
public class RegexpFactory extends RegexpMatcherFactory
{
@@ -112,11 +112,12 @@
}
/**
- * Wrapper over [EMAIL PROTECTED] RegexpMatcherFactory#createInstance
- * createInstance} that ensures that we are dealing with a Regexp
- * implementation.
+ * Wrapper over RegexpMatcherFactory.createInstance that ensures that
+ * we are dealing with a Regexp implementation.
*
* @since 1.3
+ *
+ * @see RegexpMatcherFactory#createInstance(String)
*/
protected Regexp createRegexpInstance(String classname)
throws BuildException {
1.3 +14 -10
jakarta-ant/src/main/org/apache/tools/ant/TaskContainer.java
Index: TaskContainer.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/TaskContainer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TaskContainer.java 7 Dec 2001 11:03:37 -0000 1.2
+++ TaskContainer.java 25 Feb 2002 15:33:20 -0000 1.3
@@ -1,7 +1,7 @@
/*
* The Apache Software License, Version 1.1
*
- * Copyright (c) 2001 The Apache Software Foundation. All rights
+ * Copyright (c) 2001-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -55,20 +55,24 @@
package org.apache.tools.ant;
/**
- * Interface for objects which can contain tasks
- *
- * <p>It is recommended that implementations call [EMAIL PROTECTED]
Task#perform
- * perform} instead of [EMAIL PROTECTED] Task#execute execute} for the tasks
they
- * contain, as this method ensures that [EMAIL PROTECTED] BuildEvent
BuildEvents}
- * will be generated.</p>
- *
+ * Interface for objects which can contain tasks.
+ * <p>
+ * It is recommended that implementations call perform rather than
+ * execute for the tasks they contain, as this method ensures that the
+ * appropriate BuildEvents will be generated.
+ *
+ * @see Task#perform
+ * @see Task#execute
+ * @see BuildEvent
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Conor MacNeill</a>
*/
public interface TaskContainer {
/**
- * Add a task to this task container
+ * Adds a task to this task container
*
- * @param task the task to be added to this container
+ * @param task The task to be added to this container.
+ * Must not be <code>null</code>.
*/
void addTask(Task task);
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
