I hate whinging about formatting things, but there does seem to be an
excess of whitespace here. The setCause javadoc is now so long that it
doesn't fit in one page of my editor!
Its easy to assume that this doesn't matter because javadoc is read via
HTML, but I know that I read a lot of javadoc in the source code, and I
suspect many others do to. And when you do that you want minimal visual
interference.
Stephen
(NB. I oppose all unecessary <p> & </p> as well, but [lang] voted to use
them long ago)
[EMAIL PROTECTED] wrote:
/**
- * <p>The Method object for JDK1.4 getCause.</p>
+ * <p>
+ * The Method object for Java 1.4 getCause.
+ * </p>
*/
/**
+ * <p>
+ * Sets the cause of a <code>Throwable</code> using introspection,
allowing source code compatibility between
+ * pre-1.4 and post-1.4 Java releases.
+ * </p>
+ *
+ * <p>
+ * The typical use of this method is inside a constructor as in the
following example:
+ * </p>
+ *
+ * <p>
+ * <pre>
+ * import org.apache.commons.lang.exception.ExceptionUtils;
+ *
+ * public class MyException extends Exception {
+ *
+ * public MyException(String msg) {
+ * super(msg);
+ * }
+ *
+ * public MyException(String msg, Throwable cause) {
+ * super(msg);
+ * ExceptionUtils.setCause(this, cause);
+ * }
+ *
+ * }
+ * </pre>
+ * </p>
+ *
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
