jesse 2003/04/28 08:46:03
Modified: src/main/org/apache/tools/ant/taskdefs/optional/vss MSVSS.java MSVSSADD.java MSVSSCHECKIN.java MSVSSCHECKOUT.java MSVSSCP.java MSVSSCREATE.java MSVSSGET.java MSVSSHISTORY.java MSVSSLABEL.java Log: Fix javadocs comments and add new @ant.attribute tags for xdocs Revision Changes Path 1.31 +12 -12 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java Index: MSVSS.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java,v retrieving revision 1.30 retrieving revision 1.31 diff -u -r1.30 -r1.31 --- MSVSS.java 15 Apr 2003 15:12:42 -0000 1.30 +++ MSVSS.java 28 Apr 2003 15:46:02 -0000 1.31 @@ -148,7 +148,7 @@ abstract Commandline buildCmdLine(); /** - * Directory where <code>ss.exe</code> resides; optional. + * Directory where <code>ss.exe</code> resides. * By default the task expects it to be in the PATH. * * @param dir The directory containing ss.exe. @@ -158,11 +158,10 @@ } /** - * The login to use when accessing VSS, formatted as "username,password"; - * optional. + * Login to use when accessing VSS, formatted as "username,password". * <p> * 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 @@ /** * SourceSafe path which specifies the project/file(s) you wish to perform - * the action on; required.<p> - * - * Also we strip off any 'vss://' prefix which is an XMS special and should - * probably be removed! + * the action on. + * <p> + * 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 @@ } /** - * Set the directory where <code>srssafe.ini</code> resides; optional. + * Directory where <code>srssafe.ini</code> resides. * * @param serverPath The path to the VSS server. */ @@ -204,8 +204,8 @@ } /** - * 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 @@ } /** - * 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'. */ 1.12 +10 -16 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java Index: MSVSSADD.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.java,v retrieving revision 1.11 retrieving revision 1.12 diff -u -r1.11 -r1.12 --- MSVSSADD.java 15 Apr 2003 04:26:51 -0000 1.11 +++ MSVSSADD.java 28 Apr 2003 15:46:02 -0000 1.12 @@ -60,7 +60,6 @@ /** * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * Set the autoresponce behaviour; optional. - * <p> - * 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 @@ } /** - * Set the comment to apply; optional. - * <p> - * 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 @@ } /** - * Set the local path; optional. - * <p> - * 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) { 1.17 +11 -14 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java Index: MSVSSCHECKIN.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.java,v retrieving revision 1.16 retrieving revision 1.17 diff -u -r1.16 -r1.17 --- MSVSSCHECKIN.java 10 Feb 2003 14:14:28 -0000 1.16 +++ MSVSSCHECKIN.java 28 Apr 2003 15:46:02 -0000 1.17 @@ -106,10 +106,8 @@ } /** - * Set the local path; optional. - * <p> - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * Sets the autoresponce behaviour.; optional. - * <p> - * 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 @@ } /** - * Sets the comment to apply in SourceSafe.; optional. - * <p> - * 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) { 1.17 +28 -28 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java Index: MSVSSCHECKOUT.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.java,v retrieving revision 1.16 retrieving revision 1.17 diff -u -r1.16 -r1.17 --- MSVSSCHECKOUT.java 15 Apr 2003 04:26:51 -0000 1.16 +++ MSVSSCHECKOUT.java 28 Apr 2003 15:46:03 -0000 1.17 @@ -60,13 +60,12 @@ /** * Performs CheckOut commands to Microsoft Visual SourceSafe. - * <p>If you specify two or more attributes from version, date and - * label only one will be used in the order version, date, label.</p> * * @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 @@ } /** - * Set the local path; optional. - * <p> - * 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 @@ } /** - * 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 @@ } /** - * 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. - * <p> - * 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 @@ } /** - * Set the option to the date and time given to the local copy.; optional - * - * Valid options are <code>current</code>, <code>modified</code>, or - * <code>updated</code>. Defaults to <code>current</code>. + * Date and time stamp given to the local copy. Defaults to <code>current</code>. * * @param timestamp The file time stamping behaviour. */ @@ -178,14 +180,12 @@ } /** - * Set the behaviour when local files are writable.; optional - * - * Valid options are <code>replace</code>, <code>skip</code> and <code>fail</code>. - * The default is <code>fail</code> - * + * Action taken when local files are writable. Defaults to <code>fail</code>. + * <p> * Due to ss.exe returning with an exit code of '100' for both errors and when * a file has been skipped, <code>failonerror</code> is set to false when using - * the <code>skip</code> option + * the <code>skip</code> option. + * </p> * * @param files The writable files behaviour */ @@ -194,7 +194,7 @@ } /** - * 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 */ 1.9 +2 -4 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java Index: MSVSSCP.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.java,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- MSVSSCP.java 10 Feb 2003 14:14:28 -0000 1.8 +++ MSVSSCP.java 28 Apr 2003 15:46:03 -0000 1.9 @@ -60,7 +60,6 @@ /** * Performs CP (Change Project) commands to Microsoft Visual SourceSafe. * <p>This task is typically used before a VssAdd in order to set the target project</p> - * Based on the VSS Checkin code by Martin Poeschl * * @author Nigel Magnay * @author Jesse Stockall @@ -99,9 +98,8 @@ } /** - * Sets the autoresponce behaviour.; optional. - * <p> - * 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) { 1.11 +6 -55 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java Index: MSVSSCREATE.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.java,v retrieving revision 1.10 retrieving revision 1.11 diff -u -r1.10 -r1.11 --- MSVSSCREATE.java 15 Apr 2003 04:26:51 -0000 1.10 +++ MSVSSCREATE.java 28 Apr 2003 15:46:03 -0000 1.11 @@ -59,53 +59,6 @@ /** * Creates a new project in Microsoft Visual SourceSafe. - * <p> - * The following attributes are interpreted: - * <table border="1"> - * <tr> - * <th>Attribute</th> - * <th>Values</th> - * <th>Required</th> - * </tr> - * <tr> - * <td>login</td> - * <td>username,password</td> - * <td>No</td> - * </tr> - * <tr> - * <td>vsspath</td> - * <td>SourceSafe path of project to be created</td> - * <td>Yes</td> - * </tr> - * <tr> - * <td>ssdir</td> - * <td>directory where <code>ss.exe</code> resides. By default the task - * expects it to be in the PATH.</td> - * <td>No</td> - * </tr> - * <tr> - * <td>quiet</td> - * <td>suppress output (off by default)</td> - * <td>No</td> - * </tr> - * <tr> - * <td>failOnError</td> - * <td>fail if there is an error creating the project (true by default)</td> - * <td>No</td> - * </tr> - * <tr> - * <td>autoresponse</td> - * <td>What to respond with (sets the -I option). By default, -I- is - * used; values of Y or N will be appended to this.</td> - * <td>No</td> - * </tr> - * <tr> - * <td>comment</td> - * <td>The comment to use for this label. Empty or '-' for no comment.</td> - * <td>No</td> - * </tr> - * - * </table> * * @author Gary S. Weaver * @author Jesse Stockall @@ -149,10 +102,8 @@ } /** - * Sets the comment to apply in SourceSafe.; optional. - * <p> - * 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 @@ } /** - * 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 @@ } /** - * Sets the autoresponce behaviour.; optional. - * <p> - * 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) { 1.26 +30 -88 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java Index: MSVSSGET.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.java,v retrieving revision 1.25 retrieving revision 1.26 diff -u -r1.25 -r1.26 --- MSVSSGET.java 15 Apr 2003 04:26:51 -0000 1.25 +++ MSVSSGET.java 28 Apr 2003 15:46:03 -0000 1.26 @@ -59,74 +59,14 @@ import org.apache.tools.ant.types.Path; /** - * Perform Get commands to Microsoft Visual SourceSafe. - * <p> - * The following attributes are interpreted: - * <table border="1"> - * <tr> - * <th>Attribute</th> - * <th>Values</th> - * <th>Required</th> - * </tr> - * <tr> - * <td>login</td> - * <td>username,password</td> - * <td>No</td> - * </tr> - * <tr> - * <td>vsspath</td> - * <td>SourceSafe path</td> - * <td>Yes</td> - * </tr> - * <tr> - * <td>localpath</td> - * <td>Override the working directory and get to the specified path</td> - * <td>No</td> - * </tr> - * <tr> - * <td>writable</td> - * <td>true or false</td> - * <td>No</td> - * </tr> - * <tr> - * <td>recursive</td> - * <td>true or false</td> - * <td>No</td> - * </tr> - * <tr> - * <td>version</td> - * <td>a version number to get</td> - * <td>No</td> - * </tr> - * <tr> - * <td>date</td> - * <td>a date stamp to get at</td> - * <td>No</td> - * </tr> - * <tr> - * <td>label</td> - * <td>a label to get for</td> - * <td>No</td> - * </tr> - * <tr> - * <td>quiet</td> - * <td>suppress output (off by default)</td> - * <td>No</td> - * </tr> - * <tr> - * <td>autoresponse</td> - * <td>What to respond with (sets the -I option). By default, -I- is - * used; values of Y or N will be appended to this.</td> - * <td>No</td> - * </tr> - * </table> - * <p>Note that only one of version, date or label should be specified</p> + * 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 @@ } /** - * Set the local path; optional. - * <p> - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * 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. - * <p> - * 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 @@ } /** - * Set the behavior for timestamps of local files.; optional - * - * Valid options are <code>current</code>, <code>modified</code>, or - * <code>updated</code>. Defaults to <code>current</code>. + * Date and time stamp given to the local copy. Defaults to <code>current</code>. * * @param timestamp The file time stamping behaviour. */ @@ -253,14 +198,11 @@ } /** - * Set the behavior when local files are writable.; optional - * - * Valid options are <code>replace</code>, <code>skip</code> and <code>fail</code>. - * Defaults to <code>fail</code> - * + * Action taken when local files are writable. Defaults to <code>fail</code>. + * <p> * Due to ss.exe returning with an exit code of '100' for both errors and when * a file has been skipped, <code>failonerror</code> is set to false when using - * the <code>skip</code> option + * the <code>skip</code> option. * * @param files */ 1.17 +25 -21 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java Index: MSVSSHISTORY.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.java,v retrieving revision 1.16 retrieving revision 1.17 diff -u -r1.16 -r1.17 --- MSVSSHISTORY.java 10 Feb 2003 14:14:29 -0000 1.16 +++ MSVSSHISTORY.java 28 Apr 2003 15:46:03 -0000 1.17 @@ -112,8 +112,8 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * Set the number of days for comparison; - * optional. - * <p> - * 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 @@ } /** - * 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 @@ } /** - * 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 <code>fromDate</code and <code>toDate</code>. + * Used when calculating dates with the numdays attribute. + * This string uses the formatting rules of <code>SimpleDateFormat</code>. + * Defaults to <code>DateFormat.SHORT</code>. + * * @param dateFormat The date format. */ public void setDateFormat(String dateFormat) { @@ -195,15 +199,15 @@ } /** - * Specify the output style; optional. - * - * @param attr valid values: + * Output style. Valid options are: * <ul> * <li>brief: -B Display a brief history. * <li>codediff: -D Display line-by-line file changes. * <li>nofile: -F- Do not display individual file updates in the project history. * <li>default: No option specified. Display in Source Safe's default format. * </ul> + * + * @param attr The history style: */ public void setStyle(BriefCodediffNofile attr) { String option = attr.getValue(); 1.18 +10 -55 ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java Index: MSVSSLABEL.java =================================================================== RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.java,v retrieving revision 1.17 retrieving revision 1.18 diff -u -r1.17 -r1.18 --- MSVSSLABEL.java 15 Apr 2003 04:26:51 -0000 1.17 +++ MSVSSLABEL.java 28 Apr 2003 15:46:03 -0000 1.18 @@ -60,54 +60,6 @@ /** * Performs Label commands to Microsoft Visual SourceSafe. * - * <p> - * The following attributes are interpreted: - * <table border="1"> - * <tr> - * <th>Attribute</th> - * <th>Values</th> - * <th>Required</th> - * </tr> - * <tr> - * <td>login</td> - * <td>username,password</td> - * <td>No</td> - * </tr> - * <tr> - * <td>vsspath</td> - * <td>SourceSafe path</td> - * <td>Yes</td> - * </tr> - * <tr> - * <td>ssdir</td> - * <td>directory where <code>ss.exe</code> resides. By default the task - * expects it to be in the PATH.</td> - * <td>No</td> - * </tr> - * <tr> - * <td>label</td> - * <td>A label to apply to the hierarchy</td> - * <td>Yes</td> - * </tr> - * <tr> - * <td>version</td> - * <td>An existing file or project version to label</td> - * <td>No</td> - * </tr> - * <tr> - * <td>autoresponse</td> - * <td>What to respond with (sets the -I option). By default, -I- is - * used; values of Y or N will be appended to this.</td> - * <td>No</td> - * </tr> - * <tr> - * <td>comment</td> - * <td>The comment to use for this label. Empty or '-' for no comment.</td> - * <td>No</td> - * </tr> - * - * </table> - * * @author Phillip Wells * @author Jesse Stockall * @@ -156,15 +108,19 @@ } /** - * 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 @@ } /** - * 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 @@ } /** - * Sets the autoresponce behaviour.; optional. - * <p> - * 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){