ehatcher 2002/06/19 13:15:26
Modified: src/main/org/apache/tools/ant/taskdefs/optional/ejb Tag:
ANT_15_BRANCH BorlandGenerateClient.java
src/main/org/apache/tools/ant/taskdefs/optional Tag:
ANT_15_BRANCH Cab.java
src/main/org/apache/tools/ant/taskdefs/optional/clearcase
Tag: ANT_15_BRANCH CCCheckin.java CCCheckout.java
CCUnCheckout.java CCUpdate.java ClearCase.java
src/main/org/apache/tools/ant/taskdefs/optional/ccm Tag:
ANT_15_BRANCH CCMCheck.java CCMCheckin.java
CCMCheckinDefault.java CCMCheckout.java
CCMCreateTask.java CCMReconfigure.java
Continuus.java
Log:
Javadoc cleanups for xdocs generation, now moving into the optional tasks.
Revision Changes Path
No revision
No revision
1.9.2.1 +28 -5
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/BorlandGenerateClient.java
Index: BorlandGenerateClient.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/BorlandGenerateClient.java,v
retrieving revision 1.9
retrieving revision 1.9.2.1
diff -u -r1.9 -r1.9.2.1
--- BorlandGenerateClient.java 15 Apr 2002 14:56:31 -0000 1.9
+++ BorlandGenerateClient.java 19 Jun 2002 20:15:25 -0000 1.9.2.1
@@ -71,8 +71,9 @@
/**
- * BorlandGenerateClient is dedicated to the Borland Application Server 4.5
- * This task generates the client jar using as input the ejb jar file.
+ * Generates a Borland Application Server 4.5 client JAR using as
+ * input the EJB JAR file.
+ *
* Two mode are available: java mode (default) and fork mode. With the fork
mode,
* it is impossible to add classpath to the commmand line.
*
@@ -99,21 +100,37 @@
/** hold the mode (java|fork) */
String mode = JAVA_MODE;
+ /**
+ * Command launching mode: java or fork.
+ */
public void setMode(String s) {
mode = s;
}
+
+ /**
+ * If true, turn on the debug mode for each of the Borland tools
launched.
+ */
public void setDebug(boolean debug) {
this.debug = debug;
}
+ /**
+ * EJB JAR file.
+ */
public void setEjbjar(File ejbfile) {
ejbjarfile = ejbfile;
}
-
+
+ /**
+ * Client JAR file name.
+ */
public void setClientjar(File clientjar) {
clientjarfile = clientjar;
}
+ /**
+ * Path to use for classpath.
+ */
public void setClasspath(Path classpath) {
if (this.classpath == null) {
this.classpath = classpath;
@@ -121,14 +138,20 @@
this.classpath.append(classpath);
}
}
-
+
+ /**
+ * Adds path to the classpath.
+ */
public Path createClasspath() {
if (this.classpath == null) {
this.classpath = new Path(project);
}
return this.classpath.createPath();
}
-
+
+ /**
+ * Reference to existing path, to use as a classpath.
+ */
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
No revision
No revision
1.18.2.1 +6 -8
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java
Index: Cab.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java,v
retrieving revision 1.18
retrieving revision 1.18.2.1
diff -u -r1.18 -r1.18.2.1
--- Cab.java 14 Apr 2002 11:16:15 -0000 1.18
+++ Cab.java 19 Jun 2002 20:15:25 -0000 1.18.2.1
@@ -96,44 +96,42 @@
private FileUtils fileUtils = FileUtils.newFileUtils();
/**
- * This is the name/location of where to
- * create the .cab file.
+ * The name/location of where to create the .cab file.
*/
public void setCabfile(File cabFile) {
this.cabFile = cabFile;
}
/**
- * This is the base directory to look in for
- * things to cab.
+ * Base directory to look in for files to CAB.
*/
public void setBasedir(File baseDir) {
this.baseDir = baseDir;
}
/**
- * Sets whether we want to compress the files or only store them.
+ * If true, compress the files otherwise only store them.
*/
public void setCompress(boolean compress) {
doCompress = compress;
}
/**
- * Sets whether we want to see or suppress cabarc output.
+ * If true, display cabarc output.
*/
public void setVerbose(boolean verbose) {
doVerbose = verbose;
}
/**
- * Sets additional cabarc options that aren't supported directly.
+ * Sets additional cabarc options that are not supported directly.
*/
public void setOptions(String options) {
cmdOptions = options;
}
/**
- * Adds a set of files (nested fileset attribute).
+ * Adds a set of files to archive.
*/
public void addFileset(FileSet set) {
filesets.addElement(set);
No revision
No revision
1.5.2.1 +11 -13
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java
Index: CCCheckin.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- CCCheckin.java 15 Apr 2002 14:56:31 -0000 1.5
+++ CCCheckin.java 19 Jun 2002 20:15:25 -0000 1.5.2.1
@@ -62,7 +62,8 @@
/**
- * Task to perform Checkin command to ClearCase.
+ * Performs ClearCase checkin.
+ *
* <p>
* The following attributes are interpreted:
* <table border="1">
@@ -192,7 +193,7 @@
/**
- * Set comment string
+ * Sets the comment string.
*
* @param comment the comment string
*/
@@ -210,7 +211,7 @@
}
/**
- * Set comment file
+ * Specifies a file containing a comment.
*
* @param cfile the path to the comment file
*/
@@ -228,7 +229,7 @@
}
/**
- * Set the nowarn flag
+ * If true, suppress warning messages.
*
* @param nwarn the status to set the flag to
*/
@@ -246,7 +247,7 @@
}
/**
- * Set preservetime flag
+ * If true, preserve the modification time.
*
* @param ptime the status to set the flag to
*/
@@ -264,7 +265,7 @@
}
/**
- * Set the keepcopy flag
+ * If true, keeps a copy of the file with a .keep extension.
*
* @param keep the status to set the flag to
*/
@@ -282,7 +283,8 @@
}
/**
- * Set the identical flag
+ * If true, allows the file to be checked in even
+ * if it is identical to the original.
*
* @param identical the status to set the flag to
*/
@@ -303,9 +305,7 @@
/**
* Get the 'comment' command
*
- * @return the 'comment' command if the attribute was specified,
otherwise an empty string
- *
- * @param CommandLine containing the command line string with or without
the comment flag and string appended
+ * @param cmd containing the command line string with or without the
comment flag and string appended
*/
private void getCommentCommand(Commandline cmd) {
if (getComment() != null) {
@@ -322,9 +322,7 @@
/**
* Get the 'commentfile' command
*
- * @return the 'commentfile' command if the attribute was specified,
otherwise an empty string
- *
- * @param CommandLine containing the command line string with or without
the commentfile flag and file appended
+ * @param cmd containing the command line string with or without the
commentfile flag and file appended
*/
private void getCommentFileCommand(Commandline cmd) {
if (getCommentFile() != null) {
1.5.2.1 +11 -9
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java
Index: CCCheckout.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- CCCheckout.java 15 Apr 2002 14:56:31 -0000 1.5
+++ CCCheckout.java 19 Jun 2002 20:15:25 -0000 1.5.2.1
@@ -62,7 +62,8 @@
/**
- * Task to perform Checkout command to ClearCase.
+ * Performs ClearCase checkout.
+ *
* <p>
* The following attributes are interpretted:
* <table border="1">
@@ -219,7 +220,7 @@
}
/**
- * Set reserved flag status
+ * If true, checks out the file as reserved.
*
* @param reserved the status to set the flag to
*/
@@ -237,7 +238,7 @@
}
/**
- * Set out file
+ * Creates a writable file under a different filename.
*
* @param outf the path to the out file
*/
@@ -255,7 +256,8 @@
}
/**
- * Set the nodata flag
+ * If true, checks out the file but does not create an
+ * editable file containing its data.
*
* @param ndata the status to set the flag to
*/
@@ -273,7 +275,7 @@
}
/**
- * Set branch name
+ * Specify a branch to check out the file to.
*
* @param branch the name of the branch
*/
@@ -291,7 +293,7 @@
}
/**
- * Set the version flag
+ * If true, allows checkout of a version other than main latest.
*
* @param version the status to set the flag to
*/
@@ -309,7 +311,7 @@
}
/**
- * Set the nowarn flag
+ * If true, warning messages are suppressed.
*
* @param nwarn the status to set the flag to
*/
@@ -327,7 +329,7 @@
}
/**
- * Set comment string
+ * Sets the comment string.
*
* @param comment the comment string
*/
@@ -345,7 +347,7 @@
}
/**
- * Set comment file
+ * Specifies a file containing a comment.
*
* @param cfile the path to the comment file
*/
1.5.2.1 +3 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java
Index: CCUnCheckout.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- CCUnCheckout.java 15 Apr 2002 14:56:31 -0000 1.5
+++ CCUnCheckout.java 19 Jun 2002 20:15:25 -0000 1.5.2.1
@@ -62,7 +62,8 @@
/**
- * Task to perform UnCheckout command to ClearCase.
+ * Performs ClearCase UnCheckout command.
+ *
* <p>
* The following attributes are interpretted:
* <table border="1">
@@ -138,7 +139,7 @@
}
/**
- * Set keepcopy flag status
+ * If true, keep a copy of the file with a .keep extension.
*
* @param keep the status to set the flag to
*/
1.6.2.1 +12 -10
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java
Index: CCUpdate.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- CCUpdate.java 25 Apr 2002 12:14:50 -0000 1.6
+++ CCUpdate.java 19 Jun 2002 20:15:25 -0000 1.6.2.1
@@ -63,7 +63,8 @@
/**
- * Task to perform an Update command to ClearCase.
+ * Performs a ClearCase Update command.
+ *
* <p>
* The following attributes are interpretted:
* <table border="1">
@@ -195,7 +196,7 @@
}
/**
- * Set graphical flag status
+ * If true, displays a graphical dialog during the update.
*
* @param graphical the status to set the flag to
*/
@@ -213,7 +214,7 @@
}
/**
- * Set overwrite hijacked files status
+ * If true, overwrite hijacked files.
*
* @param ow the status to set the flag to
*/
@@ -231,7 +232,7 @@
}
/**
- * Set rename hijacked files status
+ * If true, hijacked files are renamed with a .keep extension.
*
* @param ren the status to set the flag to
*/
@@ -249,7 +250,8 @@
}
/**
- * Set modified time based on current time
+ * If true, modification time should be written as the current time.
+ * Either currenttime or preservetime can be specified.
*
* @param ct the status to set the flag to
*/
@@ -267,7 +269,8 @@
}
/**
- * Preserve modified time from the VOB time
+ * If true, modification time should be preserved from the VOB time.
+ * Either currenttime or preservetime can be specified.
*
* @param pt the status to set the flag to
*/
@@ -285,7 +288,8 @@
}
/**
- * Set log file where cleartool can record the status of the command
+ * Sets the log file where cleartool records
+ * the status of the command.
*
* @param log the path to the log file
*/
@@ -305,9 +309,7 @@
/**
* Get the 'log' command
*
- * @return the 'log' command if the attribute was specified, otherwise
an empty string
- *
- * @param CommandLine containing the command line string with or without
the log flag and path appended
+ * @param cmd containing the command line string with or without the log
flag and path appended
*/
private void getLogCommand(Commandline cmd) {
if (getLog() == null) {
1.6.2.1 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.java
Index: ClearCase.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- ClearCase.java 15 Apr 2002 14:56:31 -0000 1.6
+++ ClearCase.java 19 Jun 2002 20:15:25 -0000 1.6.2.1
@@ -82,7 +82,7 @@
private String m_viewPath = null;
/**
- * Set the directory where the cleartool executable is located
+ * Set the directory where the cleartool executable is located.
*
* @param dir the directory containing the cleartool executable
*/
@@ -107,7 +107,7 @@
}
/**
- * Set the path to the item in a clearcase view to operate on
+ * Set the path to the item in a ClearCase view to operate on.
*
* @param viewPath Path to the view directory or file
*/
No revision
No revision
1.5.2.1 +5 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java
Index: CCMCheck.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- CCMCheck.java 16 Apr 2002 06:43:03 -0000 1.5
+++ CCMCheck.java 19 Jun 2002 20:15:25 -0000 1.5.2.1
@@ -63,6 +63,7 @@
/**
* Class common to all check commands (checkout, checkin,checkin default
task);
* @author Benoit Moussaud [EMAIL PROTECTED]
+ * @ant.task ignore="true"
*/
public class CCMCheck extends Continuus {
@@ -83,7 +84,7 @@
}
/**
- * Set the value of file.
+ * Sets the path to the file that the command will operate on.
* @param v Value to assign to file.
*/
public void setFile(File v) {
@@ -99,7 +100,7 @@
}
/**
- * Set the value of comment.
+ * Specifies a comment.
* @param v Value to assign to comment.
*/
public void setComment(String v) {
@@ -116,7 +117,8 @@
}
/**
- * Set the value of task.
+ * Specifies the task number used to check
+ * in the file (may use 'default').
* @param v Value to assign to task.
*/
public void setTask(String v) {
1.2.2.1 +2 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckin.java
Index: CCMCheckin.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckin.java,v
retrieving revision 1.2
retrieving revision 1.2.2.1
diff -u -r1.2 -r1.2.2.1
--- CCMCheckin.java 8 Jan 2002 23:12:44 -0000 1.2
+++ CCMCheckin.java 19 Jun 2002 20:15:25 -0000 1.2.2.1
@@ -57,7 +57,8 @@
import java.util.Date;
/**
- * Task to perform Checkin command to Continuus
+ * Performs Continuus checkin command.
+ *
* @author Benoit Moussaud [EMAIL PROTECTED]
*/
public class CCMCheckin extends CCMCheck {
1.7.2.1 +2 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckinDefault.java
Index: CCMCheckinDefault.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckinDefault.java,v
retrieving revision 1.7
retrieving revision 1.7.2.1
diff -u -r1.7 -r1.7.2.1
--- CCMCheckinDefault.java 15 Apr 2002 14:56:31 -0000 1.7
+++ CCMCheckinDefault.java 19 Jun 2002 20:15:25 -0000 1.7.2.1
@@ -55,7 +55,8 @@
package org.apache.tools.ant.taskdefs.optional.ccm;
/**
- * Task to perform Checkin Default task command to Continuus
+ * Performs Continuus Checkin Default task command.
+ *
* @author Benoit Moussaud [EMAIL PROTECTED]
*
* @ant.task name="ccmcheckintask" category="scm"
1.2.2.1 +2 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckout.java
Index: CCMCheckout.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckout.java,v
retrieving revision 1.2
retrieving revision 1.2.2.1
diff -u -r1.2 -r1.2.2.1
--- CCMCheckout.java 8 Jan 2002 23:12:44 -0000 1.2
+++ CCMCheckout.java 19 Jun 2002 20:15:25 -0000 1.2.2.1
@@ -55,7 +55,8 @@
package org.apache.tools.ant.taskdefs.optional.ccm;
/**
- * Task to perform Checkout command to Continuus
+ * Performs Continuus checkout command.
+ *
* @author Benoit Moussaud [EMAIL PROTECTED]
*/
public class CCMCheckout extends CCMCheck {
1.9.2.1 +16 -9
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java
Index: CCMCreateTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java,v
retrieving revision 1.9
retrieving revision 1.9.2.1
diff -u -r1.9 -r1.9.2.1
--- CCMCreateTask.java 25 Apr 2002 12:14:50 -0000 1.9
+++ CCMCreateTask.java 19 Jun 2002 20:15:25 -0000 1.9.2.1
@@ -68,7 +68,8 @@
/**
- * Task allows to create new ccm task and set it as the default
+ * Creates new Continuus ccm task and sets it as the default.
+ *
* @author Benoit Moussaud [EMAIL PROTECTED]
*
* @ant.task name="ccmcreatetask" category="scm"
@@ -97,7 +98,6 @@
*/
public void execute() throws BuildException {
Commandline commandLine = new Commandline();
- Project aProj = getProject();
int result = 0;
// build the command line from what we got the format
@@ -170,7 +170,8 @@
}
/**
- * Set the value of comment.
+ * Specifies a comment.
+ *
* @param v Value to assign to comment.
*/
public void setComment(String v) {
@@ -187,7 +188,8 @@
}
/**
- * Set the value of platform.
+ * Specifies the target platform.
+ *
* @param v Value to assign to platform.
*/
public void setPlatform(String v) {
@@ -204,7 +206,8 @@
}
/**
- * Set the value of resolver.
+ * Specifies the resolver.
+ *
* @param v Value to assign to resolver.
*/
public void setResolver(String v) {
@@ -221,7 +224,8 @@
}
/**
- * Set the value of release.
+ * Specify the CCM release.
+ *
* @param v Value to assign to release.
*/
public void setRelease(String v) {
@@ -237,7 +241,8 @@
}
/**
- * Set the value of subSystem.
+ * Specifies the subsystem.
+ *
* @param v Value to assign to subSystem.
*/
public void setSubSystem(String v) {
@@ -254,7 +259,9 @@
}
/**
- * Set the value of task.
+ * Specifies the task number used to checkin
+ * the file (may use 'default').
+ *
* @param v Value to assign to task.
*/
public void setTask(String v) {
@@ -317,7 +324,7 @@
/**
*
- * @param param1
+ * @param is
* @exception java.io.IOException
*/
public void setProcessErrorStream(InputStream is) throws IOException {
1.5.2.1 +4 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java
Index: CCMReconfigure.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.java,v
retrieving revision 1.5
retrieving revision 1.5.2.1
diff -u -r1.5 -r1.5.2.1
--- CCMReconfigure.java 16 Apr 2002 06:43:03 -0000 1.5
+++ CCMReconfigure.java 19 Jun 2002 20:15:25 -0000 1.5.2.1
@@ -132,7 +132,7 @@
}
/**
- * Set the value of project.
+ * Sets the ccm project on which the operation is applied.
* @param v Value to assign to project.
*/
public void setCcmProject(String v) {
@@ -149,7 +149,8 @@
}
/**
- * Set the value of recurse.
+ * If true, recurse on subproject (default false).
+ *
* @param v Value to assign to recurse.
*/
public void setRecurse(boolean v) {
@@ -166,7 +167,7 @@
}
/**
- * Set the value of verbose.
+ * If true, do a verbose reconfigure operation (default false).
* @param v Value to assign to verbose.
*/
public void setVerbose(boolean v) {
1.6.2.1 +3 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/Continuus.java
Index: Continuus.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ccm/Continuus.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- Continuus.java 15 Apr 2002 14:56:31 -0000 1.6
+++ Continuus.java 19 Jun 2002 20:15:25 -0000 1.6.2.1
@@ -90,6 +90,7 @@
/**
* Set the value of ccmAction.
* @param v Value to assign to ccmAction.
+ * @ant.attribute ignore="true"
*/
public void setCcmAction(String v) {
this.ccmAction = v;
@@ -97,7 +98,8 @@
/**
- * Set the directory where the ccm executable is located
+ * Set the directory where the ccm executable is located.
+ *
* @param dir the directory containing the ccm executable
*/
public final void setCcmDir(String dir) {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
