several javadoc fixes.

PR: 30410
Submitted by:	Brant Langer Gurganus


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277025 13f79535-47bb-0310-9956-ffa450edef68

CONTRIBUTORS

@@ -16,6 +16,7 @@ Balazs Fejes 2
 Ben Galbraith
 Benoit Moussaud
 Brad Clark
+Brant Langer Gurganus
 Brian Deitte
 Brian Felder
 Bruce Atherton

src/main/org/apache/tools/ant/helper/ProjectHelper2.java

@@ -528,7 +528,7 @@ public class ProjectHelper2 extends ProjectHelper {
     /**
      * The main handler - it handles the <project> tag.
      *
-     * @see AntHandler
+     * @see org.apache.tools.ant.helper.ProjectHelper2.AntHandler
      */
     public static class MainHandler extends AntHandler {
 

src/main/org/apache/tools/ant/taskdefs/Ant.java

@@ -334,7 +334,7 @@ public class Ant extends Task {
             // the build file if this is a top level task)?
             if (thisAntFile != null
                 && newProject.resolveFile(newProject.getProperty("ant.file"))
-                .equals(getProject().resolveFile(thisAntFile)) 
+                .equals(getProject().resolveFile(thisAntFile))
                 && getOwningTarget() != null) {
 
                 if (getOwningTarget().getName().equals("")) {
@@ -660,7 +660,7 @@ public class Ant extends Task {
 
     /**
      * Add a target to this Ant invocation.
-     * @param target   the <CODE>TargetElement</CODE> to add.
+     * @param t the <CODE>TargetElement</CODE> to add.
      * @since Ant 1.7
      */
     public void addConfiguredTarget(TargetElement t) {

src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java

@@ -192,7 +192,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     /* -------------------- */
 
     /**
-     * Set the {@link #keepgenerated} flag.
+     * Sets the <code>keepgenerated</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */
@@ -201,7 +201,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #additionalargs}.
+     * Sets the additional arguments.
      *
      * @param aString additional args.
      */
@@ -210,7 +210,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #nocompil} flag.
+     * Sets the <code>nocompil</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */
@@ -219,7 +219,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #novalidation} flag.
+     * Sets the <code>novalidation</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */
@@ -228,7 +228,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the java compiler {@link #javac} to use.
+     * Sets the java compiler to use.
      *
      * @param aString the java compiler.
      */
@@ -255,7 +255,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #secpropag} flag.
+     * Sets the <code>secpropag</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */
@@ -264,7 +264,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #verbose} flag.
+     * Sets the <code>verbose</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */
@@ -286,7 +286,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #keepgeneric} flag.
+     * Sets the <code>keepgeneric</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */
@@ -295,7 +295,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #suffix jar suffix}.
+     * Sets the jar suffix.
      *
      * @param aString the string to use as the suffix.
      */
@@ -304,7 +304,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #orb} to construct classpath.
+     * Sets the <code>orb</code> to construct classpath.
      *
      * @param aString 'RMI', 'JEREMIE', or 'DAVID'.
      */
@@ -313,7 +313,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool {
     }
 
     /**
-     * Set the {@link #nogenic} flag.
+     * Sets the <code>nogenic</code> flag.
      *
      * @param aBoolean <code>true</code> if the flag must be set.
      */

src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java

@@ -38,7 +38,6 @@ import java.util.jar.Manifest;
 public final class Extension {
     /**
      * Manifest Attribute Name object for EXTENSION_LIST.
-     * @see Attributes.Name#EXTENSION_LIST
      */
     public static final Attributes.Name EXTENSION_LIST
         = new Attributes.Name("Extension-List");
@@ -58,48 +57,41 @@ public final class Extension {
 
     /**
      * Manifest Attribute Name object for EXTENSION_NAME.
-     * @see Attributes.Name#EXTENSION_NAME
      */
     public static final Attributes.Name EXTENSION_NAME =
         new Attributes.Name("Extension-Name");
     /**
      * Manifest Attribute Name object for SPECIFICATION_VERSION.
-     * @see Attributes.Name#SPECIFICATION_VERSION
      */
     public static final Attributes.Name SPECIFICATION_VERSION
         = Attributes.Name.SPECIFICATION_VERSION;
 
     /**
      * Manifest Attribute Name object for SPECIFICATION_VENDOR.
-     * @see Attributes.Name#SPECIFICATION_VENDOR
      */
     public static final Attributes.Name SPECIFICATION_VENDOR
         = Attributes.Name.SPECIFICATION_VENDOR;
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_VERSION.
-     * @see Attributes.Name#IMPLEMENTATION_VERSION
      */
     public static final Attributes.Name IMPLEMENTATION_VERSION
         = Attributes.Name.IMPLEMENTATION_VERSION;
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_VENDOR.
-     * @see Attributes.Name#IMPLEMENTATION_VENDOR
      */
     public static final Attributes.Name IMPLEMENTATION_VENDOR
         = Attributes.Name.IMPLEMENTATION_VENDOR;
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_URL.
-     * @see Attributes.Name#IMPLEMENTATION_URL
      */
     public static final Attributes.Name IMPLEMENTATION_URL
         = new Attributes.Name("Implementation-URL");
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_VENDOR_ID.
-     * @see Attributes.Name#IMPLEMENTATION_VENDOR_ID
      */
     public static final Attributes.Name IMPLEMENTATION_VENDOR_ID
         = new Attributes.Name("Implementation-Vendor-Id");

src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java

@@ -63,7 +63,6 @@ public class LibFileSet
      * Defaults to false.
      *
      * @param includeURL the flag
-     * @see #includeURL
      */
     public void setIncludeUrl(boolean includeURL) {
         this.includeURL = includeURL;
@@ -75,7 +74,6 @@ public class LibFileSet
      * Defaults to false.
      *
      * @param includeImpl the flag
-     * @see #includeImpl
      */
     public void setIncludeImpl(boolean includeImpl) {
         this.includeImpl = includeImpl;
@@ -85,7 +83,6 @@ public class LibFileSet
      * Set the url base for fileset.
      *
      * @param urlBase the base url
-     * @see #urlBase
      */
     public void setUrlBase(String urlBase) {
         this.urlBase = urlBase;

src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java

@@ -39,42 +39,36 @@ import java.util.jar.Manifest;
 public final class Specification {
     /**
      * Manifest Attribute Name object for SPECIFICATION_TITLE.
-     * @see Attributes.Name#SPECIFICATION_TITLE
      */
     public static final Attributes.Name SPECIFICATION_TITLE
         = Attributes.Name.SPECIFICATION_TITLE;
 
     /**
      * Manifest Attribute Name object for SPECIFICATION_VERSION.
-     * @see Attributes.Name#SPECIFICATION_VERSION
      */
     public static final Attributes.Name SPECIFICATION_VERSION
         = Attributes.Name.SPECIFICATION_VERSION;
 
     /**
      * Manifest Attribute Name object for SPECIFICATION_VENDOR.
-     * @see Attributes.Name#SPECIFICATION_VENDOR
      */
     public static final Attributes.Name SPECIFICATION_VENDOR
         = Attributes.Name.SPECIFICATION_VENDOR;
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_TITLE.
-     * @see Attributes.Name#IMPLEMENTATION_TITLE
      */
     public static final Attributes.Name IMPLEMENTATION_TITLE
         = Attributes.Name.IMPLEMENTATION_TITLE;
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_VERSION.
-     * @see Attributes.Name#IMPLEMENTATION_VERSION
      */
     public static final Attributes.Name IMPLEMENTATION_VERSION
         = Attributes.Name.IMPLEMENTATION_VERSION;
 
     /**
      * Manifest Attribute Name object for IMPLEMENTATION_VENDOR.
-     * @see Attributes.Name#IMPLEMENTATION_VENDOR
      */
     public static final Attributes.Name IMPLEMENTATION_VENDOR
         = Attributes.Name.IMPLEMENTATION_VENDOR;

src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java

@@ -42,35 +42,42 @@ public class SSHUserInfo implements UserInfo {
     }
 
     /**
-     * @see com.jcraft.jsch.UserInfo#getName()
+     * Gets the user name.
+     * @return the user name
      */
     public String getName() {
         return name;
     }
 
     /**
-     * @see com.jcraft.jsch.UserInfo#getPassphrase(String)
+     * Gets the pass phrase of the user.
+     * @param message a message
+     * @return the passphrase
      */
     public String getPassphrase(String message) {
         return passphrase;
     }
 
     /**
-     * @see com.jcraft.jsch.UserInfo#getPassword()
+     * Gets the user's password.
+     * @return the user's password
      */
     public String getPassword() {
         return password;
     }
 
     /**
-     * @see com.jcraft.jsch.UserInfo#prompt(String)
+     * Prompts a string.
+     * @param str the string
+     * @return whether the string was prompted
      */
     public boolean prompt(String str) {
         return false;
     }
 
     /**
-     * @see com.jcraft.jsch.UserInfo#retry()
+     * Indicates whether a retry was done.
+     * @return whether a retry was done
      */
     public boolean retry() {
         return false;
@@ -139,16 +146,10 @@ public class SSHUserInfo implements UserInfo {
         this.keyfile = keyfile;
     }
 
-    /**
-     * @see com.jcraft.jsch.UserInfo#promptPassphrase(String)
-     */
     public boolean promptPassphrase(String message) {
         return true;
     }
 
-    /**
-     * @see com.jcraft.jsch.UserInfo#promptPassword(String)
-     */
     public boolean promptPassword(String passwordPrompt) {
         //log(passwordPrompt, Project.MSG_DEBUG);
         if (firstTime) {
@@ -158,17 +159,11 @@ public class SSHUserInfo implements UserInfo {
         return firstTime;
     }
 
-    /**
-     * @see com.jcraft.jsch.UserInfo#promptYesNo(String)
-     */
     public boolean promptYesNo(String message) {
         //log(prompt, Project.MSG_DEBUG);
         return trustAllCertificates;
     }
 
-    /**
-     * @see com.jcraft.jsch.UserInfo#showMessage(String)
-     */
     public void showMessage(String message) {
         //log(message, Project.MSG_DEBUG);
     }

src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java

@@ -169,8 +169,6 @@ public abstract class TreeBasedTask extends StarTeamTask {
      * @param rootLocalFolder
      *               the local folder that will mirror
      *               this.rootStarteamFolder
-     *
-     * @see rootLocalFolder
      */
     public void setRootLocalFolder(String rootLocalFolder) {
         this.rootLocalFolder = rootLocalFolder;
@@ -184,7 +182,6 @@ public abstract class TreeBasedTask extends StarTeamTask {
      * or null if not specified.
      *
      * @return the local folder that mirrors this.rootStarteamFolder
-     * @see rootLocalFolder
      */
     public String getRootLocalFolder() {
         return this.rootLocalFolder;

src/main/org/apache/tools/ant/types/Assertions.java

@@ -206,7 +206,7 @@ public class Assertions extends DataType implements Cloneable {
     /**
      * add the assertions to a list in a format suitable
      * for adding to a command line
-     * @param commandList
+     * @param commandIterator list of commands
      */
     public void applyAssertions(final ListIterator commandIterator) {
         getProject().log("Applying assertions", Project.MSG_DEBUG);

src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java

@@ -677,7 +677,6 @@ public class ModifiedSelector extends BaseExtendSelector implements BuildListene
      * the caller. Therefore you will get a ClassCastException if you get the
      * implementations from the selector and cast them.
      * @param loader the ClassLoader to use
-     * @see ModifiedSelectorTest#doDelayUpdateTest(int key)
      */
     public void setClassLoader(ClassLoader loader) {
         myClassLoader = loader;
@@ -710,7 +709,7 @@ public class ModifiedSelector extends BaseExtendSelector implements BuildListene
      * Defined in org.apache.tools.ant.types.Parameterizable.
      * Overwrite implementation in superclass because only special
      * parameters are valid.
-     * @see #addParam(String,String).
+     * @see #addParam(String,Object).
      */
     public void setParameters(Parameter[] parameters) {
         if (parameters != null) {

src/main/org/apache/tools/ant/util/OutputStreamFunneler.java

@@ -31,7 +31,7 @@ public class OutputStreamFunneler {
 
     /**
      * Default timeout.
-     * @see #setTimeout()
+     * @see #setTimeout(long)
      */
     public static final long DEFAULT_TIMEOUT_MILLIS = 1000;
 
@@ -97,7 +97,7 @@ public class OutputStreamFunneler {
      * specified timeout value.
      * @param out             <CODE>OutputStream</CODE>.
      * @param timeoutMillis   <CODE>long</CODE>.
-     * @see #setTimeout()
+     * @see #setTimeout(long)
      */
     public OutputStreamFunneler(OutputStream out, long timeoutMillis) {
         if (out == null) {

src/main/org/apache/tools/ant/util/WeakishReference.java

@@ -24,8 +24,8 @@ import java.lang.reflect.Constructor;
 
 
 /**
- * this is a weak reference on java1.2 and up, i.e. all
- * platforms Ant1.7 supports
+ * This is a weak reference on java1.2 and up, that is all
+ * platforms Ant1.6 supports.
  * @since ant1.6
  */
 public abstract class WeakishReference  {