From 876938476015258de6979a462387f700b631f7a2 Mon Sep 17 00:00:00 2001 From: Sam Ruby Date: Wed, 9 Feb 2000 02:01:33 +0000 Subject: [PATCH] Javadoc improvements Submitted by: Daniel Rall git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267595 13f79535-47bb-0310-9956-ffa450edef68 --- src/main/org/apache/tools/ant/BuildException.java | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/main/org/apache/tools/ant/BuildException.java b/src/main/org/apache/tools/ant/BuildException.java index f437d4810..05e358600 100644 --- a/src/main/org/apache/tools/ant/BuildException.java +++ b/src/main/org/apache/tools/ant/BuildException.java @@ -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 @@ public class BuildException extends RuntimeException { } /** - * 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 @@ public class BuildException extends RuntimeException { /** * 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 @@ public class BuildException extends RuntimeException { /** * Constructs an exception with the given exception as a root cause. + * @param cause Exception that might have caused this one. */ public BuildException(Exception cause) { super(); this.cause = cause; } -} \ No newline at end of file +}