jskeet 02/02/25 07:16:05
Modified: src/main/org/apache/tools/ant/taskdefs/optional/scm
AntStarTeamCheckOut.java
src/main/org/apache/tools/ant/taskdefs/optional/sitraka/bytecode
ClassPathLoader.java MethodInfo.java
src/main/org/apache/tools/ant/taskdefs/optional/sitraka
Coverage.java CovMerge.java CovReport.java
XMLReport.java
src/main/org/apache/tools/ant/taskdefs/optional/net
MimeMail.java
src/main/org/apache/tools/ant/taskdefs/optional/metamata
MParse.java
src/main/org/apache/tools/ant/taskdefs/optional/perforce
P4Base.java
src/main/org/apache/tools/ant/taskdefs/optional/sos
package.html SOS.java
src/main/org/apache/tools/ant/taskdefs/optional/pvcs
Pvcs.java
src/main/org/apache/tools/ant/taskdefs/optional/starteam
StarTeamCheckin.java StarTeamCheckout.java
Log:
First pass of JavaDoc work just to get rid of warnings.
When this is complete, whole source tree should JavaDoc (with 1.4)
with no warnings. (With JDK1.3.1 the 1.4-regexp stuff generates
warnings, but that's all.)
Revision Changes Path
1.12 +36 -36
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.java
Index: AntStarTeamCheckOut.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/scm/AntStarTeamCheckOut.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- AntStarTeamCheckOut.java 26 Jan 2002 20:39:13 -0000 1.11
+++ AntStarTeamCheckOut.java 25 Feb 2002 15:16:05 -0000 1.12
@@ -394,7 +394,7 @@
else
{
f = StarTeamFinder.findFolder(v.getRootFolder(),
getFolderName());
- assertTrue(null != f,"ERROR: " + getProjectName() + delim +
getViewName() + delim +
+ assertTrue(null != f,"ERROR: " + getProjectName() + delim +
getViewName() + delim +
v.getRootFolder() + delim +
getFolderName() + delim +
" does not exist.");
}
@@ -445,7 +445,7 @@
}
/**
- * returns a file object that defines the root of the local checkout tree
+ * Returns a file object that defines the root of the local checkout
tree.
* Depending on the value of targetFolderAbsolute, this will be either
* the targetFolder exactly as set by the user or the path formed by
appending
* the default folder onto the specified target folder.
@@ -453,48 +453,48 @@
* @param v view from which the file is checked out, supplies the
"default folder"
* @param rootSourceFolder root folder of the checkout operation in
Star Team
* @return an object referencing the local file
- * @see getTargetFolderAbsolute()
+ * @see #getTargetFolderAbsolute()
*/
private java.io.File calcTargetFolder(View v, Folder rootSourceFolder)
{
- java.io.File root = new java.io.File(getTargetFolder());
+ java.io.File root = new java.io.File(getTargetFolder());
if (!getTargetFolderAbsolute())
- {
- // Create a variable dir that contains the name of
- // the StarTeam folder that is the root folder in this view.
- // Get the default path to the current view.
+ {
+ // Create a variable dir that contains the name of
+ // the StarTeam folder that is the root folder in this view.
+ // Get the default path to the current view.
String defaultPath = v.getDefaultPath();
- // convert whatever separator char is in starteam to that of the
target system.
- defaultPath=defaultPath.replace('/', java.io.File.separatorChar);
- defaultPath=defaultPath.replace('\\', java.io.File.separatorChar);
+ // convert whatever separator char is in starteam to that of the
target system.
+ defaultPath=defaultPath.replace('/', java.io.File.separatorChar);
+ defaultPath=defaultPath.replace('\\', java.io.File.separatorChar);
- java.io.File dir = new java.io.File(defaultPath);
- String dirName = dir.getName();
+ java.io.File dir = new java.io.File(defaultPath);
+ String dirName = dir.getName();
// If it ends with separator then strip it off
- if (dirName.endsWith(delim))
- {
- dirName = dirName.substring(0, dirName.length()-1);
- }
-
- // Replace the projectName in the file's absolute path to the
viewName.
- // This makes the root target of a checkout operation equal to:
- // targetFolder + dirName
- StringTokenizer pathTokenizer = new
StringTokenizer(rootSourceFolder.getFolderHierarchy(), delim);
- String currentToken = null;
- boolean foundRoot = false;
- while (pathTokenizer.hasMoreTokens())
- {
- currentToken = pathTokenizer.nextToken();
- if (currentToken.equals(getProjectName()) && !foundRoot)
- {
- currentToken = dirName;
- foundRoot = true; // only want to do this the first time
- }
- root = new java.io.File(root, currentToken);
- }
- }
+ if (dirName.endsWith(delim))
+ {
+ dirName = dirName.substring(0, dirName.length()-1);
+ }
+
+ // Replace the projectName in the file's absolute path to the
viewName.
+ // This makes the root target of a checkout operation equal to:
+ // targetFolder + dirName
+ StringTokenizer pathTokenizer = new
StringTokenizer(rootSourceFolder.getFolderHierarchy(), delim);
+ String currentToken = null;
+ boolean foundRoot = false;
+ while (pathTokenizer.hasMoreTokens())
+ {
+ currentToken = pathTokenizer.nextToken();
+ if (currentToken.equals(getProjectName()) && !foundRoot)
+ {
+ currentToken = dirName;
+ foundRoot = true; // only want to do this the first time
+ }
+ root = new java.io.File(root, currentToken);
+ }
+ }
return root;
}
@@ -631,7 +631,7 @@
com.starbase.starteam.File remote = (com.starbase.starteam.File)item;
// The local file name is simply the local target path (tgt) which
has
- // been passed recursively down from the top of the tree, with the
item's name appended.
+ // been passed recursively down from the top of the tree, with the
item's name appended.
java.io.File local = new
java.io.File(tgt,(String)item.get(p1.getName()));
try
1.10 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/bytecode/ClassPathLoader.java
Index: ClassPathLoader.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/bytecode/ClassPathLoader.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ClassPathLoader.java 19 Feb 2002 21:56:33 -0000 1.9
+++ ClassPathLoader.java 25 Feb 2002 15:16:05 -0000 1.10
@@ -235,7 +235,7 @@
/**
* jar loader specified in looking for classes in jar and zip
- * @todo read the jar manifest in case there is a Class-Path
+ * To-do: read the jar manifest in case there is a Class-Path
* entry.
*/
final class JarLoader implements ClassPathLoader.FileLoader {
@@ -270,7 +270,7 @@
/**
* directory loader that will look all classes recursively
- * @todo should discard classes which package name does not
+ * To-do: should discard classes which package name does not
* match the directory ?
*/
final class DirectoryLoader implements ClassPathLoader.FileLoader {
1.5 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/bytecode/MethodInfo.java
Index: MethodInfo.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/bytecode/MethodInfo.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- MethodInfo.java 8 Jan 2002 23:57:47 -0000 1.4
+++ MethodInfo.java 25 Feb 2002 15:16:05 -0000 1.5
@@ -61,7 +61,7 @@
/**
* Method info structure.
- * @todo give a more appropriate name to methods.
+ * To-do: give a more appropriate name to methods.
*
* @author <a href="[EMAIL PROTECTED]">Stephane Bailliez</a>
*/
1.7 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.java
Index: Coverage.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Coverage.java 10 Jan 2002 13:59:38 -0000 1.6
+++ Coverage.java 25 Feb 2002 15:16:05 -0000 1.7
@@ -134,7 +134,7 @@
home = value;
}
- /** seed name for snapshot file. can be null, default to snap */
+ /** seed name for snapshot file. Can be null, default to snap */
public void setSeedname(String value) {
seedName = value;
}
@@ -192,7 +192,7 @@
}
}
- /** none, coverage, all. can be null, default to none */
+ /** none, coverage, all. Can be null, default to none */
public void setFinalsnapshot(String value) {
finalSnapshot = value;
}
1.7 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovMerge.java
Index: CovMerge.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovMerge.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- CovMerge.java 10 Jan 2002 13:59:38 -0000 1.6
+++ CovMerge.java 25 Feb 2002 15:16:05 -0000 1.7
@@ -89,7 +89,7 @@
private boolean verbose;
/**
- * set the coverage home. it must point to JProbe coverage
+ * set the coverage home. It must point to JProbe coverage
* directories where are stored native librairies and jars
*/
public void setHome(File value) {
1.9 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovReport.java
Index: CovReport.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovReport.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- CovReport.java 10 Jan 2002 13:59:38 -0000 1.8
+++ CovReport.java 25 Feb 2002 15:16:05 -0000 1.9
@@ -165,7 +165,7 @@
/**
- * Set the coverage home. it must point to JProbe coverage
+ * Set the coverage home. It must point to JProbe coverage
* directories where are stored native libraries and jars.
*/
public void setHome(File value) {
1.11 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java
Index: XMLReport.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- XMLReport.java 9 Feb 2002 20:02:59 -0000 1.10
+++ XMLReport.java 25 Feb 2002 15:16:05 -0000 1.11
@@ -259,7 +259,7 @@
}
/**
- * Convert to a CovReport-like signature ie,
<classname>.<method>()
+ * Convert to a CovReport-like signature -
<classname>.<method>().
*/
protected String getMethodSignature(ClassFile clazz, MethodInfo method) {
StringBuffer buf = new StringBuffer(clazz.getFullName());
1.6 +0 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/net/MimeMail.java
Index: MimeMail.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/net/MimeMail.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- MimeMail.java 5 Feb 2002 09:32:48 -0000 1.5
+++ MimeMail.java 25 Feb 2002 15:16:05 -0000 1.6
@@ -68,7 +68,6 @@
* @author [EMAIL PROTECTED] steve loughran
* @author [EMAIL PROTECTED] Erik Hatcher
* @author [EMAIL PROTECTED] Paulo Gaspar
- * @created 01 May 2001
*/
public class MimeMail extends EmailTask
{
1.7 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/metamata/MParse.java
Index: MParse.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/metamata/MParse.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- MParse.java 10 Jan 2002 13:59:37 -0000 1.6
+++ MParse.java 25 Feb 2002 15:16:05 -0000 1.7
@@ -73,7 +73,7 @@
/**
* Simple Metamata MParse task based on the original written by
- * <a href="mailto:[EMAIL PROTECTED]">Thomas Haas</a>
+ * <a href="mailto:[EMAIL PROTECTED]">Thomas Haas</a>.
*
* This version was written for Metamata 2.0 available at
* <a href="http://www.metamata.com";>http://www.metamata.com</a>
1.10 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java
Index: P4Base.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- P4Base.java 10 Jan 2002 13:59:38 -0000 1.9
+++ P4Base.java 25 Feb 2002 15:16:05 -0000 1.10
@@ -92,7 +92,7 @@
protected String P4Client = "";
/** Perforce User (eg fbloggs) */
protected String P4User = "";
- /** Perforce view for commands (eg //projects/foobar/main/source/... )*/
+ /** Perforce view for commands. (eg //projects/foobar/main/source/... )*/
protected String P4View = "";
//P4 g-opts and cmd opts (rtfm)
1.2 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 31 Jan 2002 19:47:40 -0000 1.1
+++ package.html 25 Feb 2002 15:16:05 -0000 1.2
@@ -1,7 +1,7 @@
<html>
<body>
<p>
- Ant tasks for working with a SourceOffSite source control system
+ Ant tasks for working with a SourceOffSite source control system.
</p>
<p>
The <SOSGet> Retreives file(s) from a SOS database<br>
1.4 +4 -4
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java
Index: SOS.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SOS.java 6 Feb 2002 01:03:26 -0000 1.3
+++ SOS.java 25 Feb 2002 15:16:05 -0000 1.4
@@ -64,7 +64,7 @@
import org.apache.tools.ant.types.Path;
/**
- * A base class for creating tasks for executing commands on SourceOffSite
+ * A base class for creating tasks for executing commands on SourceOffSite.
* <p>
* The class extends the 'exec' task as it operates by executing the
soscmd(.exe) program
* supplied with SOS. By default the task expects soscmd(.exe) to be in the
path,
@@ -169,7 +169,7 @@
/**
- * Set the path to the item in SOS to operate on
+ * Set the path to the item in SOS to operate on.
* <p>
* To avoid the "$$" in th build file we add it here
*
@@ -181,7 +181,7 @@
/**
- * Set the path to the location of the ss.ini
+ * Set the path to the location of the ss.ini.
*
* @param vssServerPath The new vssServerPath value
*/
@@ -440,7 +440,7 @@
/**
- * Builds and returns the working directory
+ * Builds and returns the working directory.
* <p>
* The localpath is created if it didn't exist
*
1.9 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java
Index: Pvcs.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Pvcs.java 2 Feb 2002 17:01:25 -0000 1.8
+++ Pvcs.java 25 Feb 2002 15:16:05 -0000 1.9
@@ -80,7 +80,7 @@
import org.apache.tools.ant.types.Commandline;
/**
- * A task that fetches source files from a PVCS archive
+ * A task that fetches source files from a PVCS archive.
*
* <b>19-04-2001</b> <p>The task now has a more robust
* parser. It allows for platform independant file paths
1.3 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.java
Index: StarTeamCheckin.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckin.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- StarTeamCheckin.java 16 Jan 2002 11:25:48 -0000 1.2
+++ StarTeamCheckin.java 25 Feb 2002 15:16:05 -0000 1.3
@@ -144,7 +144,7 @@
* This attribute tells whether unlocked files on checkin (so that
* other users may access them) checkout or to leave the checkout status
* alone (default).
- * @see setUnlocked()
+ * @see #setUnlocked(boolean)
*/
private int lockStatus = Item.LockType.UNCHANGED;
1.7 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java
Index: StarTeamCheckout.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/StarTeamCheckout.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- StarTeamCheckout.java 28 Jan 2002 03:53:35 -0000 1.6
+++ StarTeamCheckout.java 25 Feb 2002 15:16:05 -0000 1.7
@@ -135,8 +135,8 @@
* checkout locks all other users out from making changes. An unlocked
* checkout reverts all local files to their previous repository status
* and removes the lock.
- * @see setLocked()
- * @see setUnlocked()
+ * @see #setLocked(boolean)
+ * @see #setUnlocked(boolean)
*/
private int lockStatus = Item.LockType.UNCHANGED;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
