ehatcher 2002/06/18 18:22:13
Modified: src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
AbstractCvsTask.java CVSPass.java Delete.java
DependSet.java
src/main/org/apache/tools/ant/taskdefs/cvslib Tag:
ANT_15_BRANCH ChangeLogTask.java
Log:
Javadoc cleanups for xdocs generation.
Revision Changes Path
No revision
No revision
1.12.2.3 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
Index: AbstractCvsTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java,v
retrieving revision 1.12.2.2
retrieving revision 1.12.2.3
diff -u -r1.12.2.2 -r1.12.2.3
--- AbstractCvsTask.java 19 Jun 2002 00:42:43 -0000 1.12.2.2
+++ AbstractCvsTask.java 19 Jun 2002 01:22:12 -0000 1.12.2.3
@@ -510,7 +510,7 @@
}
/**
- * The package/module to check out.
+ * The package/module to operate upon.
*
* @param p
*/
@@ -524,7 +524,7 @@
}
/**
- * The tag of the package/module to check out.
+ * The tag of the package/module to operate upon.
* @param p
*/
public void setTag(String p) {
1.13.2.2 +4 -4
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/CVSPass.java
Index: CVSPass.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/CVSPass.java,v
retrieving revision 1.13.2.1
retrieving revision 1.13.2.2
diff -u -r1.13.2.1 -r1.13.2.2
--- CVSPass.java 31 May 2002 20:41:48 -0000 1.13.2.1
+++ CVSPass.java 19 Jun 2002 01:22:12 -0000 1.13.2.2
@@ -181,21 +181,21 @@
}
/**
- * Sets cvs root to be added to the password file
+ * The CVS repository to add an entry for.
*/
public void setCvsroot(String cvsRoot) {
this.cvsRoot = cvsRoot;
}
/**
- * Sets the password file attribute.
+ * Password file to add the entry to.
*/
public void setPassfile(File passFile) {
this.passFile = passFile;
}
/**
- * Sets the password attribute.
+ * Password to be added to the password file.
*/
public void setPassword(String password) {
this.password = password;
1.31.2.1 +6 -5
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Delete.java
Index: Delete.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Delete.java,v
retrieving revision 1.31
retrieving revision 1.31.2.1
diff -u -r1.31 -r1.31.2.1
--- Delete.java 15 Apr 2002 15:33:08 -0000 1.31
+++ Delete.java 19 Jun 2002 01:22:12 -0000 1.31.2.1
@@ -114,7 +114,7 @@
}
/**
- * Used to force listing of all names of deleted files.
+ * If true, list all names of deleted files.
*
* @param verbose "true" or "on"
*/
@@ -127,7 +127,7 @@
}
/**
- * If the file does not exist, do not display a diagnostic
+ * If true and the file does not exist, do not display a diagnostic
* message or modify the exit status to reflect an error.
* This means that if a file or directory cannot be deleted,
* then no error is reported. This setting emulates the
@@ -143,7 +143,8 @@
}
/**
- * this flag means 'note errors to the output, but keep going'
+ * If false, note errors but continue.
+ *
* @param failonerror true or false
*/
public void setFailOnError(boolean failonerror) {
@@ -152,14 +153,14 @@
/**
- * Used to delete empty directories.
+ * If true, delete empty directories.
*/
public void setIncludeEmptyDirs(boolean includeEmpty) {
this.includeEmpty = includeEmpty;
}
/**
- * Adds a set of files (nested fileset attribute).
+ * Adds a set of files to be deleted.
*/
public void addFileset(FileSet set) {
filesets.addElement(set);
1.15.2.2 +5 -5
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/DependSet.java
Index: DependSet.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/DependSet.java,v
retrieving revision 1.15.2.1
retrieving revision 1.15.2.2
diff -u -r1.15.2.1 -r1.15.2.2
--- DependSet.java 15 May 2002 13:20:48 -0000 1.15.2.1
+++ DependSet.java 19 Jun 2002 01:22:12 -0000 1.15.2.2
@@ -127,28 +127,28 @@
} //-- DependSet
/**
- * Nested <srcfileset> element.
+ * Add a set of source files.
*/
public void addSrcfileset(FileSet fs) {
sourceFileSets.addElement(fs);
}
/**
- * Nested <srcfilelist> element.
+ * Add a list of source files.
*/
public void addSrcfilelist(FileList fl) {
sourceFileLists.addElement(fl);
}
/**
- * Nested <targetfileset> element.
+ * Add a set of target files.
*/
public void addTargetfileset(FileSet fs) {
targetFileSets.addElement(fs);
}
/**
- * Nested <targetfilelist> element.
+ * Add a list of target files.
*/
public void addTargetfilelist(FileList fl) {
targetFileLists.addElement(fl);
No revision
No revision
1.14.2.1 +3 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java
Index: ChangeLogTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.java,v
retrieving revision 1.14
retrieving revision 1.14.2.1
diff -u -r1.14 -r1.14.2.1
--- ChangeLogTask.java 16 Apr 2002 09:26:36 -0000 1.14
+++ ChangeLogTask.java 19 Jun 2002 01:22:13 -0000 1.14.2.1
@@ -102,7 +102,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
* @version $Revision$ $Date$
* @since Ant 1.5
- * @ant.task name="changelog"
+ * @ant.task name="cvschangelog"
*/
public class ChangeLogTask extends Task {
/** User list */
@@ -192,7 +192,7 @@
/**
- * Set the numbers of days worth of log entries to process.
+ * Set the number of days worth of log entries to process.
*
* @param days the number of days of log to process.
*/
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
