ehatcher 2002/06/18 19:17:27
Modified: src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
Echo.java ExecTask.java Exit.java Filter.java
FixCRLF.java Jar.java
Log:
Javadoc cleanups for xdocs generation.
Revision Changes Path
No revision
No revision
1.20.2.1 +3 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Echo.java
Index: Echo.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Echo.java,v
retrieving revision 1.20
retrieving revision 1.20.2.1
diff -u -r1.20 -r1.20.2.1
--- Echo.java 16 Apr 2002 10:36:25 -0000 1.20
+++ Echo.java 19 Jun 2002 02:17:27 -0000 1.20.2.1
@@ -105,7 +105,7 @@
}
/**
- * Sets the message variable.
+ * Message to write.
*
* @param msg Sets the value for the message variable.
*/
@@ -114,14 +114,14 @@
}
/**
- * Sets the file attribute.
+ * File to write to.
*/
public void setFile(File file) {
this.file = file;
}
/**
- * Shall we append to an existing file?
+ * If true, append to existing file.
*/
public void setAppend(boolean append) {
this.append = append;
1.36.2.3 +4 -5
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
Index: ExecTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecTask.java,v
retrieving revision 1.36.2.2
retrieving revision 1.36.2.3
diff -u -r1.36.2.2 -r1.36.2.3
--- ExecTask.java 18 Jun 2002 20:33:29 -0000 1.36.2.2
+++ ExecTask.java 19 Jun 2002 02:17:27 -0000 1.36.2.3
@@ -166,7 +166,7 @@
/**
* Property name whose value should be set to the output of
- * the process
+ * the process.
*/
public void setOutputproperty(String outputprop) {
this.outputprop = outputprop;
@@ -187,14 +187,14 @@
}
/**
- * Add an environment variable.
+ * Add an environment variable to the launched process.
*/
public void addEnv(Environment.Variable var) {
env.addVariable(var);
}
/**
- * Add a nested arg element - a command line argument.
+ * Adds a command-line argument.
*/
public Commandline.Argument createArg() {
return cmdl.createArgument();
@@ -290,8 +290,7 @@
}
/**
- * Control whether the VM is used to launch the new process or
- * whether the OS's shell is used.
+ * If true, launch new process with VM, otherwise use the OS's shell.
*/
public void setVMLauncher(boolean vmLauncher) {
this.vmLauncher = vmLauncher;
1.16.2.1 +18 -4
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Exit.java
Index: Exit.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Exit.java,v
retrieving revision 1.16
retrieving revision 1.16.2.1
diff -u -r1.16 -r1.16.2.1
--- Exit.java 14 Apr 2002 11:16:12 -0000 1.16
+++ Exit.java 19 Jun 2002 02:17:27 -0000 1.16.2.1
@@ -59,7 +59,7 @@
/**
- * Just exit the active build, giving an additional message
+ * Exit the active build, giving an additional message
* if available.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Nico Seessle</a>
@@ -71,15 +71,29 @@
public class Exit extends Task {
private String message;
private String ifCondition, unlessCondition;
-
- public void setMessage(String value) {
+
+ /**
+ * A message giving further information on why the build exited.
+ *
+ * @param value message to output
+ */
+ public void setMessage(String value) {
this.message = value;
}
-
+
+ /**
+ * Only fail if a property of the given name exists in the current
project.
+ * @param c property name
+ */
public void setIf(String c) {
ifCondition = c;
}
+ /**
+ * Only fail if a property of the given name does not
+ * exist in the current project.
+ * @param c property name
+ */
public void setUnless(String c) {
unlessCondition = c;
}
1.16.2.1 +16 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Filter.java
Index: Filter.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Filter.java,v
retrieving revision 1.16
retrieving revision 1.16.2.1
diff -u -r1.16 -r1.16.2.1
--- Filter.java 15 Apr 2002 15:33:08 -0000 1.16
+++ Filter.java 19 Jun 2002 02:17:27 -0000 1.16.2.1
@@ -61,7 +61,7 @@
import org.apache.tools.ant.Project;
/**
- * This task sets a token filter that is used by the file copy methods
+ * Sets a token filter that is used by the file copy methods
* of the project to do token substitution, or sets mutiple tokens by
* reading these from a file.
*
@@ -79,15 +79,29 @@
private String token;
private String value;
private File filtersFile;
-
+
+ /**
+ * The token string without @ delimiters.
+ * @param token token to set
+ */
public void setToken(String token) {
this.token = token;
}
+ /**
+ * The string that should replace the token during filtered copies.
+ * @param value token replace value
+ */
public void setValue(String value) {
this.value = value;
}
+ /**
+ * The file from which the filters must be read.
+ * This file must be a formatted as a property file.
+ *
+ * @param filtersFile filter file
+ */
public void setFiltersfile(File filtersFile) {
this.filtersFile = filtersFile;
}
1.37.2.2 +17 -17
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java
Index: FixCRLF.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/FixCRLF.java,v
retrieving revision 1.37.2.1
retrieving revision 1.37.2.2
diff -u -r1.37.2.1 -r1.37.2.2
--- FixCRLF.java 4 Jun 2002 14:51:54 -0000 1.37.2.1
+++ FixCRLF.java 19 Jun 2002 02:17:27 -0000 1.37.2.2
@@ -77,7 +77,7 @@
import java.util.NoSuchElementException;
/**
- * Task to convert text source files to local OS formatting conventions, as
+ * Converts text source files to local OS formatting conventions, as
* well as repair text files damaged by misconfigured or misguided editors or
* file transfer programs.
* <p>
@@ -205,7 +205,7 @@
}
/**
- * Fixing Java source files?
+ * Set to true if modifying Java source files.
*/
public void setJavafiles(boolean javafiles) {
this.javafiles = javafiles;
@@ -213,9 +213,9 @@
/**
- * Specify how EndOfLine characters are to be handled
+ * Specify how EndOfLine characters are to be handled.
*
- * @param option valid values:
+ * @param attr valid values:
* <ul>
* <li>asis: leave line endings alone
* <li>cr: convert line endings to CR
@@ -241,7 +241,7 @@
}
/**
- * Specify how carriage return (CR) characters are to be handled
+ * Specify how carriage return (CR) characters are to be handled.
*
* @param option valid values:
* <ul>
@@ -270,9 +270,9 @@
}
/**
- * Specify how tab characters are to be handled
+ * Specify how tab characters are to be handled.
*
- * @param option valid values:
+ * @param attr valid values:
* <ul>
* <li>add: convert sequences of spaces which span a tab stop to tabs
* <li>asis: leave tab and space characters alone
@@ -292,7 +292,7 @@
}
/**
- * Specify tab length in characters
+ * Specify tab length in characters.
*
* @param tlength specify the length of tab in spaces,
*/
@@ -310,9 +310,9 @@
}
/**
- * Specify how DOS EOF (control-z) characters are to be handled
+ * Specify how DOS EOF (control-z) characters are to be handled.
*
- * @param option valid values:
+ * @param attr valid values:
* <ul>
* <li>add: ensure that there is an eof at the end of the file
* <li>asis: leave eof characters alone
@@ -617,7 +617,7 @@
* field lookahead to the first character of the state-changing token, or
* to the next eol character.
*
- * @param BufferLine bufline BufferLine containing the string
+ * @param bufline BufferLine containing the string
* to be processed
* @exception org.apache.tools.ant.BuildException
* Thrown when end of line is reached
@@ -666,9 +666,9 @@
* for the end of a character constant. Set 'lookahead' pointer to the
* character following the terminating quote.
*
- * @param BufferLine bufline BufferLine containing the string
+ * @param bufline BufferLine containing the string
* to be processed
- * @param char terminator The constant terminator
+ * @param terminator The constant terminator
*
* @exception org.apache.tools.ant.BuildException
* Thrown when end of line is reached
@@ -700,11 +700,11 @@
* The start position of the string is given by the 'next' field.
* Sets the 'next' and 'column' fields in the BufferLine.
*
- * @param BufferLine bufline BufferLine containing the string
+ * @param bufline BufferLine containing the string
* to be processed
- * @param int end Index just past the end of the
+ * @param end Index just past the end of the
* string
- * @param BufferedWriter outWriter Sink for the processed string
+ * @param outWriter Sink for the processed string
*/
private void notInConstant(OneLiner.BufferLine bufline, int end,
BufferedWriter outWriter) {
1.51.2.6 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Jar.java
Index: Jar.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Jar.java,v
retrieving revision 1.51.2.5
retrieving revision 1.51.2.6
diff -u -r1.51.2.5 -r1.51.2.6
--- Jar.java 19 Jun 2002 01:51:01 -0000 1.51.2.5
+++ Jar.java 19 Jun 2002 02:17:27 -0000 1.51.2.6
@@ -244,7 +244,7 @@
* Note: if this attribute's value is not "skip", the created jar will
not
* be readable by using java.util.jar.JarInputStream
*
- * @param config
+ * @param config setting for found manifest behavior.
*/
public void setFilesetmanifest(FilesetManifestConfig config) {
filesetManifestConfig = config;
@@ -254,7 +254,7 @@
/**
* Adds a zipfileset to include in the META-INF directory.
*
- * @param fs
+ * @param fs zipfileset to add
*/
public void addMetainf(ZipFileSet fs) {
// We just set the prefix for this fileset, and pass it up.
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
