Skip to content

Commit 70ff24d

Browse files
committed
Javadoc: Remove obsolete comments and clarify
1 parent e55e2b7 commit 70ff24d

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -439,10 +439,10 @@ static String[] getStackFrames(final String stackTrace) {
439439
* {@link Throwable} object, decomposing it into a list of
440440
* stack frames.
441441
*
442-
* <p>The result of this method vary by JDK version as this method
442+
* <p>
443+
* The result of this method vary by JDK version as this method
443444
* uses {@link Throwable#printStackTrace(java.io.PrintWriter)}.
444-
* On JDK1.3 and earlier, the cause exception will not be shown
445-
* unless the specified throwable alters printStackTrace.</p>
445+
* </p>
446446
*
447447
* @param throwable the {@link Throwable} to examine, may be null
448448
* @return an array of strings describing each stack frame, never null
@@ -455,12 +455,12 @@ public static String[] getStackFrames(final Throwable throwable) {
455455
}
456456

457457
/**
458-
* Gets the stack trace from a Throwable as a String.
458+
* Gets the stack trace from a Throwable as a String, including suppressed and cause exceptions.
459459
*
460-
* <p>The result of this method vary by JDK version as this method
460+
* <p>
461+
* The result of this method vary by JDK version as this method
461462
* uses {@link Throwable#printStackTrace(java.io.PrintWriter)}.
462-
* On JDK1.3 and earlier, the cause exception will not be shown
463-
* unless the specified throwable alters printStackTrace.</p>
463+
* </p>
464464
*
465465
* @param throwable the {@link Throwable} to be examined, may be null
466466
* @return the stack trace as generated by the exception's
@@ -716,17 +716,19 @@ public static boolean isUnchecked(final Throwable throwable) {
716716
/**
717717
* Prints a compact stack trace for the root cause of a throwable
718718
* to {@code System.err}.
719-
*
720-
* <p>The compact stack trace starts with the root cause and prints
719+
* <p>
720+
* The compact stack trace starts with the root cause and prints
721721
* stack frames up to the place where it was caught and wrapped.
722722
* Then it prints the wrapped exception and continues with stack frames
723-
* until the wrapper exception is caught and wrapped again, etc.</p>
724-
*
725-
* <p>The output of this method is consistent across JDK versions.
726-
* Note that this is the opposite order to the JDK1.4 display.</p>
727-
*
728-
* <p>The method is equivalent to {@code printStackTrace} for throwables
729-
* that don't have nested causes.</p>
723+
* until the wrapper exception is caught and wrapped again, etc.
724+
* </p>
725+
* <p>
726+
* The output of this method is consistent across JDK versions.
727+
* </p>
728+
* <p>
729+
* The method is equivalent to {@code printStackTrace} for throwables
730+
* that don't have nested causes.
731+
* </p>
730732
*
731733
* @param throwable the throwable to output
732734
* @since 2.0

0 commit comments

Comments
 (0)