diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java index a0e05129f..54a3f16e0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java @@ -148,7 +148,7 @@ public abstract class MSVSS extends Task implements MSVSSConstants { abstract Commandline buildCmdLine(); /** - * Directory where ss.exe resides; optional. + * Directory where ss.exe resides. * By default the task expects it to be in the PATH. * * @param dir The directory containing ss.exe. @@ -158,11 +158,10 @@ public abstract class MSVSS extends Task implements MSVSSConstants { } /** - * The login to use when accessing VSS, formatted as "username,password"; - * optional. + * Login to use when accessing VSS, formatted as "username,password". *

* You can omit the password if your database is not password protected. - * if you have a password and omit it, Ant/VSS will hang. + * If you have a password and omit it, Ant will hang. * * @param login The login string to use. */ @@ -172,12 +171,13 @@ public abstract class MSVSS extends Task implements MSVSSConstants { /** * SourceSafe path which specifies the project/file(s) you wish to perform - * the action on; required.

- * - * Also we strip off any 'vss://' prefix which is an XMS special and should - * probably be removed! + * the action on. + *

+ * A prefix of 'vss://' will be removed if specified. * * @param vssPath The VSS project path. + * + * @ant.attribute group="required" */ public final void setVsspath(String vssPath) { String projectPath; @@ -195,7 +195,7 @@ public abstract class MSVSS extends Task implements MSVSSConstants { } /** - * Set the directory where srssafe.ini resides; optional. + * Directory where srssafe.ini resides. * * @param serverPath The path to the VSS server. */ @@ -204,8 +204,8 @@ public abstract class MSVSS extends Task implements MSVSSConstants { } /** - * Sets behaviour, whether task should fail if there is an error creating - * the project.; optional, default true + * Indicates if the build should fail if the Sourcesafe command does. Defaults to true. + * * @param failOnError True if task should fail on any error. */ public final void setFailOnError (boolean failOnError) { @@ -597,7 +597,7 @@ public abstract class MSVSS extends Task implements MSVSSConstants { } /** - * Gets the value of the fail on error flag. + * Gets the value of the fail on error flag. * * @return True if the FailOnError flag has been set or if 'writablefiles=skip'. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java index 2f7c990b3..f2a9280c0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java @@ -60,7 +60,6 @@ import org.apache.tools.ant.types.Path; /** * Performs Add commands to Microsoft Visual SourceSafe. - * Based on the VSS Checkin code by Martin Poeschl * * @author Nigel Magnay * @author Jesse Stockall @@ -116,8 +115,8 @@ public class MSVSSADD extends MSVSS { } /** - * Flag to tell the task to recurse down the tree; - * optional, default false. + * Add files recursively. Defaults to false. + * * @param recursive The boolean value for recursive. */ public void setRecursive(boolean recursive) { @@ -125,8 +124,8 @@ public class MSVSSADD extends MSVSS { } /** - * Sets behaviour, unset the READ-ONLY flag on files added to VSS.; - * optional, default false + * Unset the READ-ONLY flag on local copies of files added to VSS. Defaults to false. + * * @param writable The boolean value for writable. */ public final void setWritable(boolean writable) { @@ -134,9 +133,8 @@ public class MSVSSADD extends MSVSS { } /** - * Set the autoresponce behaviour; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response){ @@ -144,10 +142,8 @@ public class MSVSSADD extends MSVSS { } /** - * Set the comment to apply; optional. - *

- * If this is null or empty, it will be replaced with "-" which - * is what SourceSafe uses for an empty comment. + * Comment to apply to files added to SourceSafe. + * * @param comment The comment to apply in SourceSafe */ public void setComment(String comment) { @@ -155,10 +151,8 @@ public class MSVSSADD extends MSVSS { } /** - * Set the local path; optional. - *

- * This is the path to override the project - * working directory. + * Override the project working directory. + * * @param localPath The path on disk. */ public void setLocalpath(Path localPath) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java index f795fb6a7..5d7dd15c9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java @@ -106,10 +106,8 @@ public class MSVSSCHECKIN extends MSVSS { } /** - * Set the local path; optional. - *

- * This is the path to override the project - * working directory. + * Override the project working directory. + * * @param localPath The path on disk. */ public void setLocalpath(Path localPath) { @@ -117,8 +115,8 @@ public class MSVSSCHECKIN extends MSVSS { } /** - * Flag to tell the task to recurse down the tree; - * optional, default false. + * Check-in files recursively. Defaults to false. + * * @param recursive The boolean value for recursive. */ public void setRecursive(boolean recursive) { @@ -126,7 +124,9 @@ public class MSVSSCHECKIN extends MSVSS { } /** - * Sets behaviour, unset the READ-ONLY flag on files checkedin to VSS.; optional + * Unset the READ-ONLY flag on local copies of files checked-in to VSS. + * Defaults to false. + * * @param writable The boolean value for writable. */ public final void setWritable(boolean writable) { @@ -134,9 +134,8 @@ public class MSVSSCHECKIN extends MSVSS { } /** - * Sets the autoresponce behaviour.; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response){ @@ -144,10 +143,8 @@ public class MSVSSCHECKIN extends MSVSS { } /** - * Sets the comment to apply in SourceSafe.; optional. - *

- * If this is null or empty, it will be replaced with "-" which - * is what SourceSafe uses for an empty comment. + * Comment to apply to files checked-in to SourceSafe. + * * @param comment The comment to apply in SourceSafe */ public void setComment(String comment) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java index 424f68880..c4288f96d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java @@ -60,13 +60,12 @@ import org.apache.tools.ant.types.Path; /** * Performs CheckOut commands to Microsoft Visual SourceSafe. - *

If you specify two or more attributes from version, date and - * label only one will be used in the order version, date, label.

* * @author Martin Poeschl * @author Jesse Stockall * * @ant.task name="vsscheckout" category="scm" + * @ant.attribute.group name="vdl" description="Only one of version, date or label" */ public class MSVSSCHECKOUT extends MSVSS { @@ -112,10 +111,8 @@ public class MSVSSCHECKOUT extends MSVSS { } /** - * Set the local path; optional. - *

- * This is the path to override the project - * working directory. + * Override the project working directory. + * * @param localPath The path on disk. */ public void setLocalpath(Path localPath) { @@ -123,8 +120,8 @@ public class MSVSSCHECKOUT extends MSVSS { } /** - * Flag to tell the task to recurse down the tree; - * optional, default false. + * Check-out files recursively. Defaults to false. + * * @param recursive The boolean value for recursive. */ public void setRecursive(boolean recursive) { @@ -132,33 +129,41 @@ public class MSVSSCHECKOUT extends MSVSS { } /** - * Sets the stored version string.; optional. - * @param version The version to checkout. + * Version to check-out. + * + * @param version The version to check-out. + * + * @ant.attribute group="vdl" */ public void setVersion(String version) { super.setInternalVersion(version); } /** - * Sets the stored date string.; optional. - * @param date The date to checkout. + * Date to check-out. + * + * @param date The date to check-out. + * + * @ant.attribute group="vdl" */ public void setDate(String date) { super.setInternalDate(date); } /** - * Sets the label to apply in SourceSafe.; optional. - * @param label The label to apply. + * Label to check-out. + * + * @param label The label to check-out. + * + * @ant.attribute group="vdl" */ public void setLabel(String label) { super.setInternalLabel(label); } /** - * Sets the autoresponce behaviour.; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response){ @@ -166,10 +171,7 @@ public class MSVSSCHECKOUT extends MSVSS { } /** - * Set the option to the date and time given to the local copy.; optional - * - * Valid options are current, modified, or - * updated. Defaults to current. + * Date and time stamp given to the local copy. Defaults to current. * * @param timestamp The file time stamping behaviour. */ @@ -178,14 +180,12 @@ public class MSVSSCHECKOUT extends MSVSS { } /** - * Set the behaviour when local files are writable.; optional - * - * Valid options are replace, skip and fail. - * The default is fail - * + * Action taken when local files are writable. Defaults to fail. + *

* Due to ss.exe returning with an exit code of '100' for both errors and when * a file has been skipped, failonerror is set to false when using - * the skip option + * the skip option. + *

* * @param files The writable files behaviour */ @@ -194,7 +194,7 @@ public class MSVSSCHECKOUT extends MSVSS { } /** - * Set the behaviour to retrieve local copies during a checkout.; optional, Defaults to true. + * Retrieve a local copy during a checkout. Defaults to true. * * @param get The get local copy behaviour */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java index 20fb33dd7..5eaf71562 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java @@ -60,7 +60,6 @@ import org.apache.tools.ant.types.Commandline; /** * Performs CP (Change Project) commands to Microsoft Visual SourceSafe. *

This task is typically used before a VssAdd in order to set the target project

- * Based on the VSS Checkin code by Martin Poeschl * * @author Nigel Magnay * @author Jesse Stockall @@ -99,9 +98,8 @@ public class MSVSSCP extends MSVSS { } /** - * Sets the autoresponce behaviour.; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java index c19b4e911..a5b730a98 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java @@ -59,53 +59,6 @@ import org.apache.tools.ant.types.Commandline; /** * Creates a new project in Microsoft Visual SourceSafe. - *

- * The following attributes are interpreted: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
AttributeValuesRequired
loginusername,passwordNo
vsspathSourceSafe path of project to be createdYes
ssdirdirectory where ss.exe resides. By default the task - * expects it to be in the PATH.No
quietsuppress output (off by default)No
failOnErrorfail if there is an error creating the project (true by default)No
autoresponseWhat to respond with (sets the -I option). By default, -I- is - * used; values of Y or N will be appended to this.No
commentThe comment to use for this label. Empty or '-' for no comment.No
* * @author Gary S. Weaver * @author Jesse Stockall @@ -149,10 +102,8 @@ public class MSVSSCREATE extends MSVSS { } /** - * Sets the comment to apply in SourceSafe.; optional. - *

- * If this is null or empty, it will be replaced with "-" which - * is what SourceSafe uses for an empty comment. + * Comment to apply to the project created in SourceSafe. + * * @param comment The comment to apply in SourceSafe */ public void setComment(String comment) { @@ -160,7 +111,8 @@ public class MSVSSCREATE extends MSVSS { } /** - * Sets/clears quiet mode; optional, default false. + * Enable quiet mode. Defaults to false. + * * @param quiet The boolean value for quiet. */ public final void setQuiet (boolean quiet) { @@ -168,9 +120,8 @@ public class MSVSSCREATE extends MSVSS { } /** - * Sets the autoresponce behaviour.; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java index 886e13ae6..7b7b62a55 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java @@ -59,74 +59,14 @@ import org.apache.tools.ant.types.Commandline; import org.apache.tools.ant.types.Path; /** - * Perform Get commands to Microsoft Visual SourceSafe. - *

- * The following attributes are interpreted: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
AttributeValuesRequired
loginusername,passwordNo
vsspathSourceSafe pathYes
localpathOverride the working directory and get to the specified pathNo
writabletrue or falseNo
recursivetrue or falseNo
versiona version number to getNo
datea date stamp to get atNo
labela label to get forNo
quietsuppress output (off by default)No
autoresponseWhat to respond with (sets the -I option). By default, -I- is - * used; values of Y or N will be appended to this.No
- *

Note that only one of version, date or label should be specified

+ * Perform Get commands from Microsoft Visual SourceSafe. * * @author Craig Cottingham * @author Andrew Everitt * @author Jesse Stockall * * @ant.task name="vssget" category="scm" + * @ant.attribute.group name="vdl" description="Only one of version, date or label" */ public class MSVSSGET extends MSVSS { @@ -171,10 +111,8 @@ public class MSVSSGET extends MSVSS { } /** - * Set the local path; optional. - *

- * This is the path to override the project - * working directory. + * Override the project working directory. + * * @param localPath The path on disk. */ public void setLocalpath(Path localPath) { @@ -182,8 +120,8 @@ public class MSVSSGET extends MSVSS { } /** - * Flag to tell the task to recurse down the tree; - * optional, default false. + * Get files recursively. Defaults to false. + * * @param recursive The boolean value for recursive. */ public final void setRecursive(boolean recursive) { @@ -191,7 +129,8 @@ public class MSVSSGET extends MSVSS { } /** - * Sets/clears quiet mode; optional, default false. + * Enable quiet mode. Defaults to false. + * * @param quiet The boolean value for quiet. */ public final void setQuiet (boolean quiet) { @@ -199,7 +138,8 @@ public class MSVSSGET extends MSVSS { } /** - * Sets behaviour, unset the READ-ONLY flag on files retrieved from VSS.; optional, default false + * Unset the READ-ONLY flag on files retrieved from VSS. Defaults to false. + * * @param writable The boolean value for writable. */ public final void setWritable(boolean writable) { @@ -207,33 +147,41 @@ public class MSVSSGET extends MSVSS { } /** - * Sets the stored version string.; optional. + * Version to get. + * * @param version The version to get. + * + * @ant.attribute group="vdl" */ public void setVersion(String version) { super.setInternalVersion(version); } /** - * Sets the stored date string.; optional. - * @param date The date to checkout. + * Date to get. + * + * @param date The date to get. + * + * @ant.attribute group="vdl" */ public void setDate(String date) { super.setInternalDate(date); } /** - * Sets the label to apply in SourceSafe.; optional. - * @param label The label to apply. + * Label to get. + * + * @param label The label to get. + * + * @ant.attribute group="vdl" */ public void setLabel(String label) { super.setInternalLabel(label); } /** - * Sets the autoresponce behaviour.; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response){ @@ -241,10 +189,7 @@ public class MSVSSGET extends MSVSS { } /** - * Set the behavior for timestamps of local files.; optional - * - * Valid options are current, modified, or - * updated. Defaults to current. + * Date and time stamp given to the local copy. Defaults to current. * * @param timestamp The file time stamping behaviour. */ @@ -253,14 +198,11 @@ public class MSVSSGET extends MSVSS { } /** - * Set the behavior when local files are writable.; optional - * - * Valid options are replace, skip and fail. - * Defaults to fail - * + * Action taken when local files are writable. Defaults to fail. + *

* Due to ss.exe returning with an exit code of '100' for both errors and when * a file has been skipped, failonerror is set to false when using - * the skip option + * the skip option. * * @param files */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java index 376203047..b1326cbed 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java @@ -112,8 +112,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Flag to tell the task to recurse down the tree; - * optional, default false. + * Retrieve history recursively. Defaults to false. + * * @param recursive The boolean value for recursive. */ public void setRecursive(boolean recursive) { @@ -121,7 +121,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Sets the username of the user whose changes we would like to see.; optional + * Name of the user whose change history is generated. + * * @param user The username. */ public void setUser(String user) { @@ -129,8 +130,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Set the Start Date for the comparison of two versions in SourceSafe - * history.; optional + * Date representing the 'start' of the range. + * * @param fromDate The start date. */ public void setFromDate(String fromDate) { @@ -138,7 +139,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Set the End Date for the Comparison of two versions; optional. + * Date representing the 'end' of the range. + * * @param toDate The end date. */ public void setToDate(String toDate) { @@ -146,7 +148,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Set the Start Label; optional. + * Label representing the 'start' of the range. + * * @param fromLabel The start label. */ public void setFromLabel(String fromLabel) { @@ -154,7 +157,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Set the End label; optional. + * Label representing the 'end' of the range. + * * @param toLabel The end label. */ public void setToLabel(String toLabel) { @@ -162,10 +166,9 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Set the number of days for comparison; - * optional. - *

- * The default value is 2 days. (maybe) + * Number of days for comparison. + * Defaults to 2 days. + * * @param numd The number of days. */ public void setNumdays(int numd) { @@ -173,7 +176,8 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Set the output file name for the history; optional. + * Output file name for the history. + * * @param outfile The output file name. */ public void setOutput(File outfile) { @@ -183,11 +187,11 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Format of dates in fromDate and toDate; optional. - * Used when calculating dates with - * the numdays attribute. - * This string uses the formatting rules of SimpleDateFormat. - * Defaults to DateFormat.SHORT. + * Format of dates in fromDatetoDate. + * Used when calculating dates with the numdays attribute. + * This string uses the formatting rules of SimpleDateFormat. + * Defaults to DateFormat.SHORT. + * * @param dateFormat The date format. */ public void setDateFormat(String dateFormat) { @@ -195,15 +199,15 @@ public class MSVSSHISTORY extends MSVSS { } /** - * Specify the output style; optional. - * - * @param attr valid values: + * Output style. Valid options are: *

+ * + * @param attr The history style: */ public void setStyle(BriefCodediffNofile attr) { String option = attr.getValue(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java index ad3cd75f5..81343b319 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java @@ -60,54 +60,6 @@ import org.apache.tools.ant.types.Commandline; /** * Performs Label commands to Microsoft Visual SourceSafe. * - *

- * The following attributes are interpreted: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
AttributeValuesRequired
loginusername,passwordNo
vsspathSourceSafe pathYes
ssdirdirectory where ss.exe resides. By default the task - * expects it to be in the PATH.No
labelA label to apply to the hierarchyYes
versionAn existing file or project version to labelNo
autoresponseWhat to respond with (sets the -I option). By default, -I- is - * used; values of Y or N will be appended to this.No
commentThe comment to use for this label. Empty or '-' for no comment.No
- * * @author Phillip Wells * @author Jesse Stockall * @@ -156,15 +108,19 @@ public class MSVSSLABEL extends MSVSS { } /** - * Set the label to apply in SourceSafe.; required. + * Label to apply in SourceSafe. + * * @param label The label to apply. + * + * @ant.attribute group="required" */ public void setLabel(String label) { super.setInternalLabel(label); } /** - * Set the stored version string.; optional. + * Version to label. + * * @param version The version to label. */ public void setVersion(String version) { @@ -172,8 +128,8 @@ public class MSVSSLABEL extends MSVSS { } /** - * The comment to use for this label.; optional. - * Empty or '-' for no comment. + * Comment to apply to files labeled in SourceSafe. + * * @param comment The comment to apply in SourceSafe */ public void setComment(String comment) { @@ -181,9 +137,8 @@ public class MSVSSLABEL extends MSVSS { } /** - * Sets the autoresponce behaviour.; optional. - *

- * Valid options are Y and N. + * Autoresponce behaviour. Valid options are Y and N. + * * @param response The auto response value. */ public void setAutoresponse(String response){