From 342a4d69cb2fe6b7fcd5a80877e687771dbbd5d1 Mon Sep 17 00:00:00 2001 From: Jesse Stockall Date: Fri, 25 Apr 2003 21:10:02 +0000 Subject: [PATCH] Fix the javadoc comments and add @ant.attribute tags for xdocs documentation generation git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@274518 13f79535-47bb-0310-9956-ffa450edef68 --- .../tools/ant/taskdefs/optional/sos/SOS.java | 38 ++++--- .../ant/taskdefs/optional/sos/SOSCheckin.java | 94 ++---------------- .../taskdefs/optional/sos/SOSCheckout.java | 87 ++-------------- .../ant/taskdefs/optional/sos/SOSGet.java | 99 ++----------------- .../ant/taskdefs/optional/sos/SOSLabel.java | 67 ++----------- 5 files changed, 50 insertions(+), 335 deletions(-) diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java index e822d9b87..7bdddb200 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java @@ -94,8 +94,9 @@ public abstract class SOS extends Task implements SOSCmd { protected Commandline commandLine; /** - * Flag to disable the cache when set; - * optional needed if SOSHOME is set as an environment variable., default false + * Flag to disable the cache when set. + * Required if SOSHOME is set as an environment variable. + * Defaults to false. * * @param nocache True to disable caching. */ @@ -104,7 +105,7 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Flag that disables compression when set; optional, default false + * Flag to disable compression when set. Defaults to false. * * @param nocompress True to disable compression. */ @@ -113,8 +114,8 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Set the directory where soscmd(.exe) is located; - * optional, soscmd must be on the path if omitted. + * The directory where soscmd(.exe) is located. + * soscmd must be on the path if omitted. * * @param dir The new sosCmd value */ @@ -123,16 +124,18 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Set the SourceSafe username; required. + * The SourceSafe username. * * @param username The new username value + * + * @ant.attribute group="required" */ public final void setUsername(String username) { sosUsername = username; } /** - * Set the SourceSafe password; optional. + * The SourceSafe password. * * @param password The new password value */ @@ -141,9 +144,11 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Set the SourceSafe project path; required. + * The SourceSafe project path. * * @param projectpath The new projectpath value + * + * @ant.attribute group="required" */ public final void setProjectPath(String projectpath) { if (projectpath.startsWith(SOSCmd.PROJECT_PREFIX)) { @@ -154,17 +159,18 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Set the path to the location of the ss.ini file; - * required. + * The path to the location of the ss.ini file. * * @param vssServerPath The new vssServerPath value + * + * @ant.attribute group="required" */ public final void setVssServerPath(String vssServerPath) { this.vssServerPath = vssServerPath; } /** - * The path to the SourceOffSite home directory + * Path to the SourceOffSite home directory. * * @param sosHome The new sosHome value */ @@ -173,17 +179,19 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Sets the address and port of SourceOffSite Server, - * for example 192.168.0.1:8888.; required. + * The address and port of SourceOffSite Server, + * for example 192.168.0.1:8888. * * @param sosServerPath The new sosServerPath value + * + * @ant.attribute group="required" */ public final void setSosServerPath(String sosServerPath) { this.sosServerPath = sosServerPath; } /** - * Override the working directory and get to the specified path; optional. + * Override the working directory and get to the specified path. * * @param path The new localPath value */ @@ -192,7 +200,7 @@ public abstract class SOS extends Task implements SOSCmd { } /** - * Enable verbose output; optional, default false + * Enable verbose output. Defaults to false. * * @param verbose True for verbose output. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java index 618991cd4..a31edae15 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.java @@ -58,95 +58,16 @@ import org.apache.tools.ant.types.Commandline; /** * Commits and unlocks files in Visual SourceSafe via a SourceOffSite server. * - *

- * The following attributes are interpretted: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
AttributeValuesRequired
soscmddirDirectory which contains soscmd(.exe)
- * soscmd(.exe) must be in the path if this is not specified		No
vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
projectpathSourceSafe project pathYes
fileFilename to act upon
If no file is specified then act upon the project		No
usernameSourceSafe usernameYes
passwordSourceSafe passwordNo
localpathOverride the working directory and get to the specified pathNo
soshomeThe path to the SourceOffSite home directoryNo
nocompressiontrue or false - disable compressionNo
recursivetrue or false - Only works with the CheckOutProject commandNo
nocachetrue or false - Only needed if SOSHOME is set as an enviroment variableNo
verbosetrue or false - Status messages are displayedNo
commentA comment to be applied to all files being checked inNo
- * * @author Jesse Stockall + * + * @ant.task name="soscheckin" category="scm" */ - public class SOSCheckin extends SOS { /** - * Set the Filename to act upon; optional. - * If no file is specified then the tasks - * act upon the project + * The filename to act upon. + * If no file is specified then the task + * acts upon the project. * * @param filename The new file value */ @@ -155,7 +76,7 @@ public class SOSCheckin extends SOS { } /** - * Flag to recursively apply the action; optional, default false + * Flag to recursively apply the action. Defaults to false. * * @param recursive True for recursive operation. */ @@ -164,8 +85,7 @@ public class SOSCheckin extends SOS { } /** - * Set the comment to apply to all files being labelled; - * optional + * The comment to apply to all files being labelled. * * @param comment The new comment value */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java index f90882689..af96050be 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.java @@ -58,91 +58,16 @@ import org.apache.tools.ant.types.Commandline; /** * Retrieves and locks files in Visual SourceSafe via a SourceOffSite server. * - *

- * The following attributes are interpretted: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
AttributeValuesRequired
soscmddirDirectory which contains soscmd(.exe)
- * soscmd(.exe) must be in the path if this is not specified		No
vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
projectpathSourceSafe project pathYes
fileFilename to act upon
If no file is specified then act upon the project		No
usernameSourceSafe usernameYes
passwordSourceSafe passwordNo
localpathOverride the working directory and get to the specified pathNo
soshomeThe path to the SourceOffSite home directoryNo
nocompressiontrue or false - disable compressionNo
recursivetrue or false - Only works with the CheckOutProject commandNo
nocachetrue or false - Only needed if SOSHOME is set as an enviroment variableNo
verbosetrue or false - Status messages are displayedNo
- * * @author Jesse Stockall + * + * @ant.task name="soscheckout" category="scm" */ - public class SOSCheckout extends SOS { /** - * Set the Filename to act upon; optional. - * If no file is specified then the tasks - * act upon the project + * The filename to act upon. + * If no file is specified then the task + * acts upon the project. * * @param filename The new file value */ @@ -151,7 +76,7 @@ public class SOSCheckout extends SOS { } /** - * Flag to recursively apply the action; optional, default false + * Flag to recursively apply the action. Defaults to false. * * @param recursive True for recursive operation. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java index f20582952..01825dd30 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.java @@ -58,102 +58,17 @@ import org.apache.tools.ant.types.Commandline; /** * Retrieves a read-only copy of the specified project or file * from Visual SourceSafe via a SourceOffSite server. - *

- * The following attributes are interpretted: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * * * @author Jesse Stockall + * + * @ant.task name="sosget" category="scm" */ - public class SOSGet extends SOS { /** - * Set the Filename to act upon; optional. + * The Filename to act upon. * If no file is specified then the tasks - * act upon the project + * act upon the project. * * @param filename The new file value */ @@ -162,7 +77,7 @@ public class SOSGet extends SOS { } /** - * Flag to recursively apply the action; optional, default false + * Flag to recursively apply the action. Defaults to false * * @param recursive True for recursive operation. */ @@ -172,7 +87,7 @@ public class SOSGet extends SOS { /** * Set the version number to get - - * only works with SOSGet on a file; optional. + * only works with SOSGet on a file. * * @param version The new version value */ @@ -181,7 +96,7 @@ public class SOSGet extends SOS { } /** - * Set the labeled version to operate on in SourceSafe + * The labeled version to operate on in SourceSafe. * * @param label The new label value */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java index 9eb3e029d..84bd28d4d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java @@ -58,69 +58,15 @@ import org.apache.tools.ant.types.Commandline; /** * Labels Visual SourceSafe files via a SourceOffSite server. - *

- * The following attributes are interpreted: - *

AttributeValuesRequired
soscmddirDirectory which contains soscmd(.exe)
- * soscmd(.exe) must be in the path if this is not specified		No
vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
projectpathSourceSafe project pathYes
fileFilename to act upon
- * If no file is specified then act upon the project		No
usernameSourceSafe usernameYes
passwordSourceSafe passwordNo
localpathOverride the working directory and get to the specified pathNo
soshomeThe path to the SourceOffSite home directoryNo
nocompressiontrue or false - disable compressionNo
recursivetrue or false - Only works with the GetProject commandNo
versiona version number to get - Only works with the GetFile commandNo
labela label version to get - Only works with the GetProject commandNo
nocachetrue or false - Only needed if SOSHOME is set as an enviroment variableNo
verbosetrue or false - Status messages are displayedNo
- * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
AttributeValuesRequired
soscmddirDirectory which contains soscmd(.exe)
- * soscmd(.exe) must be in the path if this is not specified		No
vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
projectpathSourceSafe projectYes
usernameSourceSafe usernameYes
passwordSourceSafe passwordNo
labelThe label to apply to a projectYes
commentA comment to be applied to all files being labeledNo
verbosetrue or false - Status messages are displayedNo
* * @author Jesse Stockall + * + * @ant.task name="soslabel" category="scm" */ - public class SOSLabel extends SOS { /** - * Set the version number to label; optional. + * The version number to label. * * @param version The new version value */ @@ -129,17 +75,18 @@ public class SOSLabel extends SOS { } /** - * Set the label to apply the the files in SourceSafe. + * The label to apply the the files in SourceSafe. * * @param label The new label value + * + * @ant.attribute group="required" */ public void setLabel(String label) { super.setInternalLabel(label); } /** - * Set the comment to apply to all files being labelled; - * optional + * The comment to apply to all files being labelled. * * @param comment The new comment value */