You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by Daniel Rall <dl...@finemaltcoding.com> on 2000/02/09 02:15:05 UTC

[PATCH] JavaDoc addition

Could a committer please look this over and commit?  Thanks...

dlr@drac:ant$ diff -u BuildException.java BuildException.java-DLR

--- BuildException.java Tue Feb  8 17:09:36 2000
+++ BuildException.java-DLR     Tue Feb  8 17:10:27 2000
@@ -55,18 +55,18 @@
 package org.apache.tools.ant;

 /**
- * Signals an error condition.
+ * Signals an error condition during a build.
  *
  * @author James Duncan Davidson
  */

 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() {
@@ -74,7 +74,8 @@
     }

     /**
-     * Constructs an exception with the given message.
+     * Constructs an exception with the given descriptive 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,6 +96,7 @@

     /**
      * Constructs an exception with the given exception as a root
cause.
+     * @param cause Exception that might have caused this one.
      */

     public BuildException(Exception cause) {