ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/util OutputStreamFunneler.java WeakishReference.java
Date Fri, 12 Nov 2004 11:07:13 GMT
bodewig     2004/11/12 03:07:13

  Modified:    .        CONTRIBUTORS
               src/main/org/apache/tools/ant/helper ProjectHelper2.java
               src/main/org/apache/tools/ant/taskdefs Ant.java
               src/main/org/apache/tools/ant/taskdefs/optional/ejb
                        JonasDeploymentTool.java
               src/main/org/apache/tools/ant/taskdefs/optional/extension
                        Extension.java LibFileSet.java Specification.java
               src/main/org/apache/tools/ant/taskdefs/optional/ssh
                        SSHUserInfo.java
               src/main/org/apache/tools/ant/taskdefs/optional/starteam
                        TreeBasedTask.java
               src/main/org/apache/tools/ant/types Assertions.java
               src/main/org/apache/tools/ant/types/selectors/modifiedselector
                        ModifiedSelector.java
               src/main/org/apache/tools/ant/util OutputStreamFunneler.java
                        WeakishReference.java
  Log:
  several javadoc fixes.
  
  PR: 30410
  Submitted by:	Brant Langer Gurganus
  
  Revision  Changes    Path
  1.38      +1 -0      ant/CONTRIBUTORS
  
  Index: CONTRIBUTORS
  ===================================================================
  RCS file: /home/cvs/ant/CONTRIBUTORS,v
  retrieving revision 1.37
  retrieving revision 1.38
  diff -u -r1.37 -r1.38
  --- CONTRIBUTORS	5 Nov 2004 15:03:00 -0000	1.37
  +++ CONTRIBUTORS	12 Nov 2004 11:07:12 -0000	1.38
  @@ -16,6 +16,7 @@
   Ben Galbraith
   Benoit Moussaud
   Brad Clark
  +Brant Langer Gurganus
   Brian Deitte
   Brian Felder
   Bruce Atherton
  
  
  
  1.50      +1 -1      ant/src/main/org/apache/tools/ant/helper/ProjectHelper2.java
  
  Index: ProjectHelper2.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/helper/ProjectHelper2.java,v
  retrieving revision 1.49
  retrieving revision 1.50
  diff -u -r1.49 -r1.50
  --- ProjectHelper2.java	26 Oct 2004 14:56:55 -0000	1.49
  +++ ProjectHelper2.java	12 Nov 2004 11:07:12 -0000	1.50
  @@ -528,7 +528,7 @@
       /**
        * The main handler - it handles the <project> tag.
        *
  -     * @see AntHandler
  +     * @see org.apache.tools.ant.helper.ProjectHelper2.AntHandler
        */
       public static class MainHandler extends AntHandler {
   
  
  
  
  1.107     +2 -2      ant/src/main/org/apache/tools/ant/taskdefs/Ant.java
  
  Index: Ant.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/Ant.java,v
  retrieving revision 1.106
  retrieving revision 1.107
  diff -u -r1.106 -r1.107
  --- Ant.java	31 Aug 2004 22:32:53 -0000	1.106
  +++ Ant.java	12 Nov 2004 11:07:12 -0000	1.107
  @@ -334,7 +334,7 @@
               // 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 @@
   
       /**
        * 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) {
  
  
  
  1.16      +11 -11    ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java
  
  Index: JonasDeploymentTool.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- JonasDeploymentTool.java	9 Mar 2004 16:48:21 -0000	1.15
  +++ JonasDeploymentTool.java	12 Nov 2004 11:07:12 -0000	1.16
  @@ -192,7 +192,7 @@
       /* -------------------- */
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * Set the {@link #additionalargs}.
  +     * Sets the additional arguments.
        *
        * @param aString additional args.
        */
  @@ -210,7 +210,7 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * Set the java compiler {@link #javac} to use.
  +     * Sets the java compiler to use.
        *
        * @param aString the java compiler.
        */
  @@ -255,7 +255,7 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * Set the {@link #suffix jar suffix}.
  +     * Sets the jar suffix.
        *
        * @param aString the string to use as the suffix.
        */
  @@ -304,7 +304,7 @@
       }
   
       /**
  -     * 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 @@
       }
   
       /**
  -     * Set the {@link #nogenic} flag.
  +     * Sets the <code>nogenic</code> flag.
        *
        * @param aBoolean <code>true</code> if the flag must be set.
        */
  
  
  
  1.14      +1 -9      ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java
  
  Index: Extension.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- Extension.java	5 Nov 2004 15:02:05 -0000	1.13
  +++ Extension.java	12 Nov 2004 11:07:12 -0000	1.14
  @@ -38,7 +38,6 @@
   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 @@
   
       /**
        * 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");
  
  
  
  1.8       +1 -4      ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java
  
  Index: LibFileSet.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- LibFileSet.java	9 Mar 2004 16:48:24 -0000	1.7
  +++ LibFileSet.java	12 Nov 2004 11:07:12 -0000	1.8
  @@ -63,7 +63,6 @@
        * Defaults to false.
        *
        * @param includeURL the flag
  -     * @see #includeURL
        */
       public void setIncludeUrl(boolean includeURL) {
           this.includeURL = includeURL;
  @@ -75,7 +74,6 @@
        * Defaults to false.
        *
        * @param includeImpl the flag
  -     * @see #includeImpl
        */
       public void setIncludeImpl(boolean includeImpl) {
           this.includeImpl = includeImpl;
  @@ -85,7 +83,6 @@
        * Set the url base for fileset.
        *
        * @param urlBase the base url
  -     * @see #urlBase
        */
       public void setUrlBase(String urlBase) {
           this.urlBase = urlBase;
  
  
  
  1.10      +1 -7      ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java
  
  Index: Specification.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- Specification.java	14 Apr 2004 15:42:07 -0000	1.9
  +++ Specification.java	12 Nov 2004 11:07:12 -0000	1.10
  @@ -39,42 +39,36 @@
   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;
  
  
  
  1.9       +12 -17    ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java
  
  Index: SSHUserInfo.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- SSHUserInfo.java	9 Mar 2004 16:48:37 -0000	1.8
  +++ SSHUserInfo.java	12 Nov 2004 11:07:12 -0000	1.9
  @@ -42,35 +42,42 @@
       }
   
       /**
  -     * @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 @@
           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 @@
           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);
       }
  
  
  
  1.27      +0 -3      ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java
  
  Index: TreeBasedTask.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/starteam/TreeBasedTask.java,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  --- TreeBasedTask.java	14 Apr 2004 15:42:07 -0000	1.26
  +++ TreeBasedTask.java	12 Nov 2004 11:07:12 -0000	1.27
  @@ -169,8 +169,6 @@
        * @param rootLocalFolder
        *               the local folder that will mirror
        *               this.rootStarteamFolder
  -     *
  -     * @see rootLocalFolder
        */
       public void setRootLocalFolder(String rootLocalFolder) {
           this.rootLocalFolder = rootLocalFolder;
  @@ -184,7 +182,6 @@
        * or null if not specified.
        *
        * @return the local folder that mirrors this.rootStarteamFolder
  -     * @see rootLocalFolder
        */
       public String getRootLocalFolder() {
           return this.rootLocalFolder;
  
  
  
  1.16      +1 -1      ant/src/main/org/apache/tools/ant/types/Assertions.java
  
  Index: Assertions.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/Assertions.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- Assertions.java	20 Apr 2004 06:24:25 -0000	1.15
  +++ Assertions.java	12 Nov 2004 11:07:13 -0000	1.16
  @@ -206,7 +206,7 @@
       /**
        * 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);
  
  
  
  1.11      +1 -2      ant/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java
  
  Index: ModifiedSelector.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- ModifiedSelector.java	30 Sep 2004 12:41:52 -0000	1.10
  +++ ModifiedSelector.java	12 Nov 2004 11:07:13 -0000	1.11
  @@ -677,7 +677,6 @@
        * 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 @@
        * 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) {
  
  
  
  1.2       +2 -2      ant/src/main/org/apache/tools/ant/util/OutputStreamFunneler.java
  
  Index: OutputStreamFunneler.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/util/OutputStreamFunneler.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- OutputStreamFunneler.java	27 Mar 2004 21:22:58 -0000	1.1
  +++ OutputStreamFunneler.java	12 Nov 2004 11:07:13 -0000	1.2
  @@ -31,7 +31,7 @@
   
       /**
        * Default timeout.
  -     * @see #setTimeout()
  +     * @see #setTimeout(long)
        */
       public static final long DEFAULT_TIMEOUT_MILLIS = 1000;
   
  @@ -97,7 +97,7 @@
        * 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) {
  
  
  
  1.16      +2 -2      ant/src/main/org/apache/tools/ant/util/WeakishReference.java
  
  Index: WeakishReference.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/util/WeakishReference.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- WeakishReference.java	22 Apr 2004 14:48:31 -0000	1.15
  +++ WeakishReference.java	12 Nov 2004 11:07:13 -0000	1.16
  @@ -24,8 +24,8 @@
   
   
   /**
  - * 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  {
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message