[PATCH] Added some JavaDoc comments for method parameters of class org.apache.tools.ant.BuildException

["Daniel L. Rall" <dl...@finemaltcoding.com>]

Small JavaDoc addition.

--- BuildException.java-ORIG	Sat Feb  5 20:36:32 2000
+++ BuildException.java	Sat Feb  5 20:38:18 2000
@@ -62,11 +62,11 @@
 
 public class BuildException extends RuntimeException {
 
-    /** Exception that might have caused this one */
+    /** Exception that might have caused this one. */
     private Exception cause;
 
     /**
-     * Constructs an exception with no information.
+     * Constructs a build exception with no descriptive information.
      */
     
     public BuildException() {
@@ -75,6 +75,7 @@
 
     /**
      * Constructs an exception with the given message.
+     * @param msg Description of or information about the exception.
      */
     
     public BuildException(String msg) {
@@ -84,6 +85,8 @@
     /**
      * Constructs an exception with the given message and exception as
      * a root cause.
+     * @param msg Description of or information about the exception.
+     * @param cause Exception that might have cause this one.
      */
 
     public BuildException(String msg, Exception cause) {
@@ -93,10 +96,11 @@
     
     /**
      * Constructs an exception with the given exception as a root
cause.
+     * @param cause Exception that might have cause this one.
      */
     
     public BuildException(Exception cause) {
 	super();
 	this.cause = cause;
     }
-}
\ No newline at end of file
+}

-- 

Daniel L. Rall (dlr@finemaltcoding.com)