This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 70ff24dda Javadoc: Remove obsolete comments and clarify
70ff24dda is described below
commit 70ff24dda0271d18f1a1c422c865ae2917b80e93
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Jan 6 10:20:25 2025 -0500
Javadoc: Remove obsolete comments and clarify
---
.../commons/lang3/exception/ExceptionUtils.java | 34 ++++++++++++----------
1 file changed, 18 insertions(+), 16 deletions(-)
diff --git
a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
index 3a912fa18..a832f0448 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
@@ -439,10 +439,10 @@ public class ExceptionUtils {
* {@link Throwable} object, decomposing it into a list of
* stack frames.
*
- * <p>The result of this method vary by JDK version as this method
+ * <p>
+ * The result of this method vary by JDK version as this method
* uses {@link Throwable#printStackTrace(java.io.PrintWriter)}.
- * On JDK1.3 and earlier, the cause exception will not be shown
- * unless the specified throwable alters printStackTrace.</p>
+ * </p>
*
* @param throwable the {@link Throwable} to examine, may be null
* @return an array of strings describing each stack frame, never null
@@ -455,12 +455,12 @@ public class ExceptionUtils {
}
/**
- * Gets the stack trace from a Throwable as a String.
+ * Gets the stack trace from a Throwable as a String, including suppressed
and cause exceptions.
*
- * <p>The result of this method vary by JDK version as this method
+ * <p>
+ * The result of this method vary by JDK version as this method
* uses {@link Throwable#printStackTrace(java.io.PrintWriter)}.
- * On JDK1.3 and earlier, the cause exception will not be shown
- * unless the specified throwable alters printStackTrace.</p>
+ * </p>
*
* @param throwable the {@link Throwable} to be examined, may be null
* @return the stack trace as generated by the exception's
@@ -716,17 +716,19 @@ public class ExceptionUtils {
/**
* Prints a compact stack trace for the root cause of a throwable
* to {@code System.err}.
- *
- * <p>The compact stack trace starts with the root cause and prints
+ * <p>
+ * The compact stack trace starts with the root cause and prints
* stack frames up to the place where it was caught and wrapped.
* Then it prints the wrapped exception and continues with stack frames
- * until the wrapper exception is caught and wrapped again, etc.</p>
- *
- * <p>The output of this method is consistent across JDK versions.
- * Note that this is the opposite order to the JDK1.4 display.</p>
- *
- * <p>The method is equivalent to {@code printStackTrace} for throwables
- * that don't have nested causes.</p>
+ * until the wrapper exception is caught and wrapped again, etc.
+ * </p>
+ * <p>
+ * The output of this method is consistent across JDK versions.
+ * </p>
+ * <p>
+ * The method is equivalent to {@code printStackTrace} for throwables
+ * that don't have nested causes.
+ * </p>
*
* @param throwable the throwable to output
* @since 2.0
