From 5aae1b3e8d1c9e4fce5c763520c961b9f174f4d8 Mon Sep 17 00:00:00 2001 From: Steve Loughran Date: Thu, 22 Nov 2001 08:46:55 +0000 Subject: [PATCH] Erik's big javadoc fixup, bugzilla ID #4992 git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269989 13f79535-47bb-0310-9956-ffa450edef68 --- .../tools/ant/listener/Log4jListener.java | 2 +- .../org/apache/tools/ant/taskdefs/Ant.java | 18 +++++++++--------- .../apache/tools/ant/taskdefs/CallTarget.java | 18 +++++++++--------- .../apache/tools/ant/taskdefs/DependSet.java | 4 ++-- .../org/apache/tools/ant/taskdefs/Exit.java | 2 +- .../org/apache/tools/ant/taskdefs/Javac.java | 4 ++-- .../apache/tools/ant/taskdefs/Property.java | 4 ++-- .../apache/tools/ant/taskdefs/Recorder.java | 2 +- .../org/apache/tools/ant/taskdefs/Replace.java | 6 +++--- .../ant/taskdefs/optional/Native2Ascii.java | 2 +- .../ant/taskdefs/optional/PropertyFile.java | 2 +- .../taskdefs/optional/ccm/CCMCreateTask.java | 10 +++++----- .../optional/ejb/BorlandDeploymentTool.java | 8 ++++---- .../optional/ejb/DescriptorHandler.java | 4 ++-- .../ant/taskdefs/optional/jsp/WLJspc.java | 16 ++++++++-------- .../ant/taskdefs/optional/net/TelnetTask.java | 6 +++--- .../taskdefs/optional/perforce/P4Label.java | 5 ++++- .../tools/ant/taskdefs/optional/pvcs/Pvcs.java | 6 +++--- .../ant/taskdefs/optional/sitraka/Socket.java | 2 +- .../taskdefs/optional/sitraka/XMLReport.java | 2 +- .../tools/ant/taskdefs/rmic/KaffeRmic.java | 2 +- .../tools/ant/taskdefs/rmic/RmicAdapter.java | 2 +- .../ant/taskdefs/rmic/RmicAdapterFactory.java | 2 +- .../tools/ant/taskdefs/rmic/SunRmic.java | 2 +- .../apache/tools/ant/taskdefs/rmic/WLRmic.java | 2 +- .../apache/tools/ant/types/Description.java | 2 +- 26 files changed, 69 insertions(+), 66 deletions(-) diff --git a/src/main/org/apache/tools/ant/listener/Log4jListener.java b/src/main/org/apache/tools/ant/listener/Log4jListener.java index d61641b67..5a59cd293 100644 --- a/src/main/org/apache/tools/ant/listener/Log4jListener.java +++ b/src/main/org/apache/tools/ant/listener/Log4jListener.java @@ -67,7 +67,7 @@ import org.apache.log4j.helpers.NullEnumeration; /** * Listener which sends events to Log4j logging system * - * @author Conor MacNeill */ public class Log4jListener implements BuildListener { final static String LOG4J_CONFIG_PROPERTY = "log4j.configuration"; diff --git a/src/main/org/apache/tools/ant/taskdefs/Ant.java b/src/main/org/apache/tools/ant/taskdefs/Ant.java index c0b272993..c9c008c72 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Ant.java +++ b/src/main/org/apache/tools/ant/taskdefs/Ant.java @@ -73,16 +73,16 @@ import java.util.Enumeration; * Call Ant in a sub-project * * 
- *    
- *    
- *      
- *      
- *     
- *  
+ *  <target name="foo" depends="init">
+ *    <ant antfile="build.xml" target="bar" >
+ *      <property name="property1" value="aaaaa" />
+ *      <property name="foo" value="baz" />
+ *    </ant>
+ *  </target>
  *
- * 
- *    
- * 
+ *  <target name="bar" depends="init">
+ *    <echo message="prop is ${property1} ${foo}" />
+ *  </target>
  *
* * diff --git a/src/main/org/apache/tools/ant/taskdefs/CallTarget.java b/src/main/org/apache/tools/ant/taskdefs/CallTarget.java index 22925ef40..14c5eb0d4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/CallTarget.java +++ b/src/main/org/apache/tools/ant/taskdefs/CallTarget.java @@ -61,16 +61,16 @@ import org.apache.tools.ant.BuildException; * Call another target in the same project. * * 
- *    
- *      
- *        
- *        
- *       
- *    
+ *    <target name="foo">
+ *      <antcall target="bar">
+ *        <param name="property1" value="aaaaa" />
+ *        <param name="foo" value="baz" />
+ *       </antcall>
+ *    </target>
  *
- *    
- *      
- *    
+ *    <target name="bar" depends="init">
+ *      <echo message="prop is ${property1} ${foo}" />
+ *    </target>
  *
* *

This only works as expected if neither property1 nor foo are diff --git a/src/main/org/apache/tools/ant/taskdefs/DependSet.java b/src/main/org/apache/tools/ant/taskdefs/DependSet.java index 6c8cf1464..16da47966 100644 --- a/src/main/org/apache/tools/ant/taskdefs/DependSet.java +++ b/src/main/org/apache/tools/ant/taskdefs/DependSet.java @@ -95,7 +95,7 @@ import org.apache.tools.ant.types.FileList; * source vs target combination unnecessarily. *

* Example uses: - *

  • + * * * @author Craeg Strong * @version $Revision$ $Date$ diff --git a/src/main/org/apache/tools/ant/taskdefs/Exit.java b/src/main/org/apache/tools/ant/taskdefs/Exit.java index 9b3060e9b..8687a5819 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Exit.java +++ b/src/main/org/apache/tools/ant/taskdefs/Exit.java @@ -62,7 +62,7 @@ import org.apache.tools.ant.ProjectHelper; * Just exit the active build, giving an additional message * if available. * - * @author Nico Seessle + * @author Nico Seessle */ public class Exit extends Task { private String message; diff --git a/src/main/org/apache/tools/ant/taskdefs/Javac.java b/src/main/org/apache/tools/ant/taskdefs/Javac.java index ca91c9d13..881cf9a4c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Javac.java +++ b/src/main/org/apache/tools/ant/taskdefs/Javac.java @@ -168,10 +168,10 @@ public class Javac extends MatchingTask { } /** - * Create a nested element for multiple source path + * Create a nested src element for multiple source path * support. * - * @return a nexted src element. + * @return a nested src element. */ public Path createSrc() { if (src == null) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java index 5d666604e..95ead748e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Property.java +++ b/src/main/org/apache/tools/ant/taskdefs/Property.java @@ -74,8 +74,8 @@ import java.util.Enumeration; * Will not override values set by the command line or parent projects. * * @author costin@dnt.ro - * @author Sam Ruby - * @author Glenn McAllister + * @author Sam Ruby + * @author Glenn McAllister */ public class Property extends Task { diff --git a/src/main/org/apache/tools/ant/taskdefs/Recorder.java b/src/main/org/apache/tools/ant/taskdefs/Recorder.java index 29f6a26fe..36cf4e721 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Recorder.java +++ b/src/main/org/apache/tools/ant/taskdefs/Recorder.java @@ -70,7 +70,7 @@ import java.util.Hashtable; /** * This task is the manager for RecorderEntry's. It is this class - * that holds all entries, modifies them every time the + * that holds all entries, modifies them every time the <recorder> * task is called, and addes them to the build listener process. * @see RecorderEntry * @author J D Glanville diff --git a/src/main/org/apache/tools/ant/taskdefs/Replace.java b/src/main/org/apache/tools/ant/taskdefs/Replace.java index 4e9264040..d9c5128f5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Replace.java +++ b/src/main/org/apache/tools/ant/taskdefs/Replace.java @@ -463,7 +463,7 @@ public class Replace extends MatchingTask { } /** - * Nested element. + * Nested <replacetoken> element. */ public NestedString createReplaceToken() { if (token == null) { @@ -473,7 +473,7 @@ public class Replace extends MatchingTask { } /** - * Nested element. + * Nested <replacevalue> element. */ public NestedString createReplaceValue() { return value; @@ -487,7 +487,7 @@ public class Replace extends MatchingTask { } /** - * Add nested element. + * Add nested <replacefilter> element. */ public Replacefilter createReplacefilter() { Replacefilter filter = new Replacefilter(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java b/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java index 72cb8645c..5a6689142 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/Native2Ascii.java @@ -69,7 +69,7 @@ import java.io.File; /** * Convert files from native encodings to ascii. * - * @author Drew Sudell + * @author Drew Sudell * @author Stefan Bodewig */ public class Native2Ascii extends MatchingTask { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java b/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java index 02ad75810..da43b3ccb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/PropertyFile.java @@ -149,7 +149,7 @@ import java.text.DecimalFormat; *a newline delimiter charater. * * @author Thomas Christen chr@active.ch - * @author Jeremy Mawson jem@loftinspace.com.au */ public class PropertyFile extends Task { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java index 9a28ce730..df818022a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java @@ -295,7 +295,7 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler { /** * - * @exception java.io.IOException + * @exception java.io.IOException */ public void start() throws IOException { } @@ -308,16 +308,16 @@ public class CCMCreateTask extends Continuus implements ExecuteStreamHandler { /** * - * @param param1 - * @exception java.io.IOException + * @param param1 + * @exception java.io.IOException */ public void setProcessInputStream(OutputStream param1) throws IOException { } /** * - * @param param1 - * @exception java.io.IOException + * @param param1 + * @exception java.io.IOException */ public void setProcessErrorStream(InputStream is) throws IOException { BufferedReader reader = new BufferedReader(new InputStreamReader(is)); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.java index 6cfaf47b6..9b43a098b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.java @@ -431,8 +431,8 @@ public class BorlandDeploymentTool extends GenericDeploymentTool implements Exe /** * - * @param param1 - * @exception java.io.IOException + * @param is + * @exception java.io.IOException */ public void setProcessOutputStream(InputStream is) throws IOException { @@ -458,8 +458,8 @@ public class BorlandDeploymentTool extends GenericDeploymentTool implements Exe } /** - * @param param1 - * @exception java.io.IOException + * @param param1 + * @exception java.io.IOException */ public void setProcessErrorStream(InputStream is) throws IOException { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java index c72465bc1..7305b180a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.java @@ -132,7 +132,7 @@ public class DescriptorHandler extends org.xml.sax.HandlerBase { protected Hashtable ejbFiles = null; /** - * Instance variable that stores the value found in the element + * Instance variable that stores the value found in the <ejb-name> element */ protected String ejbName = null; @@ -243,7 +243,7 @@ public class DescriptorHandler extends org.xml.sax.HandlerBase { } /** - * Getter method that returns the value of the element. + * Getter method that returns the value of the <ejb-name> element. */ public String getEjbName() { return ejbName; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java index 51d45b43b..c2ea18b2e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java @@ -100,15 +100,15 @@ import java.util.StringTokenizer; * * 
      * example
- * 
- *   
- *   
- *          
- *           
- *      
+ * <target name="jspcompile" depends="compile">
+ *   <wljspc src="c:\\weblogic\\myserver\\public_html" dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp">
+ *   <classpath>
+ *          <pathelement location="${weblogic.classpath}" />
+ *           <pathelement path="${compile.dest}" />
+ *      </classpath>
  * 
- *   
- * 
+ *   </wljspc>
+ * </target>
  *
    * */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java index caf6954e6..7d8aac23e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java @@ -69,7 +69,7 @@ import java.util.Vector; /** * Class to provide automated telnet protocol support for the Ant build tool * - * @author Scott CarlsonScottCarlson@email.com + * @author ScottCarlson@email.com * @version $Revision$ */ @@ -206,7 +206,7 @@ public class TelnetTask extends Task { } /** - * A subTask tag was found. Create the object, + * A subTask <read> tag was found. Create the object, * Save it in our list, and return it. */ @@ -218,7 +218,7 @@ public class TelnetTask extends Task { } /** - * A subTask tag was found. Create the object, + * A subTask <write> tag was found. Create the object, * Save it in our list, and return it. */ public TelnetSubTask createWrite() diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java index 681b417c1..720afdfb6 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java @@ -72,7 +72,10 @@ import java.text.SimpleDateFormat; * * Label name defaults to AntLabel if none set. * - * Example Usage: + * Example Usage: + * 
    + *   <P4Label name="MyLabel-${TSTAMP}-${DSTAMP}" desc="Auto Build Label" />
+ *
    * * @author Les Hughes */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java index 725eaffea..cce46015b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java @@ -93,9 +93,9 @@ import org.apache.tools.ant.types.Commandline; * update those files that have a modification time (in PVCS) that is newer * than the existing workfile. * - * @author Thomas Christensen - * @author Don Jeffery - * @author Steven E. Newton + * @author Thomas Christensen + * @author Don Jeffery + * @author Steven E. Newton */ public class Pvcs extends org.apache.tools.ant.Task { private String pvcsbin; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java b/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java index e6e7d20d7..59e76eab8 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Socket.java @@ -78,7 +78,7 @@ public class Socket { port = value.intValue(); } - /** if no host is set, returning ':', will take localhost */ + /** if no host is set, returning ':<port>', will take localhost */ public String toString() { return host + ":" + port; } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java b/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java index 378a8895e..32c87c34b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/XMLReport.java @@ -258,7 +258,7 @@ public class XMLReport { } /** - * Convert to a CovReport-like signature ie, .() + * Convert to a CovReport-like signature ie, <classname>.<method>() */ protected String getMethodSignature(ClassFile clazz, MethodInfo method) { StringBuffer buf = new StringBuffer(clazz.getFullName()); diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.java b/src/main/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.java index 7a249f606..64569e148 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.java @@ -66,7 +66,7 @@ import java.lang.reflect.Method; /** * The implementation of the rmic for Kaffe * - * @author Takashi Okamoto + * @author Takashi Okamoto */ public class KaffeRmic extends DefaultRmicAdapter { diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java b/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java index 608cfe88a..81817b003 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java @@ -69,7 +69,7 @@ import org.apache.tools.ant.util.FileNameMapper; * task, the execute command and a parameterless constructor (for * reflection).

    * - * @author Takashi Okamoto + * @author Takashi Okamoto * @author Stefan Bodewig */ diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.java b/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.java index d6e5d2319..651978378 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.java @@ -61,7 +61,7 @@ import org.apache.tools.ant.Task; /** * Creates the necessary rmic adapter, given basic criteria. * - * @author Takashi Okamoto + * @author Takashi Okamoto * @author J D Glanville */ public class RmicAdapterFactory { diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/SunRmic.java b/src/main/org/apache/tools/ant/taskdefs/rmic/SunRmic.java index 5ab10e890..b8b0af1a7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/SunRmic.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/SunRmic.java @@ -67,7 +67,7 @@ import java.lang.reflect.Method; /** * The implementation of the rmic for SUN's JDK. * - * @author Takashi Okamoto + * @author Takashi Okamoto */ public class SunRmic extends DefaultRmicAdapter { diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/WLRmic.java b/src/main/org/apache/tools/ant/taskdefs/rmic/WLRmic.java index 8e48ab7a3..14136be68 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/WLRmic.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/WLRmic.java @@ -67,7 +67,7 @@ import java.lang.reflect.Method; /** * The implementation of the rmic for WebLogic * - * @author Takashi Okamoto + * @author Takashi Okamoto */ public class WLRmic extends DefaultRmicAdapter { diff --git a/src/main/org/apache/tools/ant/types/Description.java b/src/main/org/apache/tools/ant/types/Description.java index 5eff47053..062f33729 100644 --- a/src/main/org/apache/tools/ant/types/Description.java +++ b/src/main/org/apache/tools/ant/types/Description.java @@ -59,7 +59,7 @@ package org.apache.tools.ant.types; /** * Description is used to provide a project-wide description element * (that is, a description that applies to a buildfile as a whole). - * If present, the element is printed out before the + * If present, the <description> element is printed out before the * target descriptions. * * Description has no attributes, only text. There can only be one