Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixing reversed Javadoc descriptions (#781) 

The descriptions for `formatTime()` and `formatSplitTime()` were reversed; the former said "Returns the split time" and the latter said "returns the time".

This PR switches their descriptions so that they now match the behavior of the methods.
This commit is contained in:
Thunderforge 2021-08-24 08:34:12 -05:00 committed by GitHub
parent a8f18fc98e
commit 7941cfd255
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/org/apache/commons/lang3/time/StopWatch.java
View File

@ -249,9 +249,9 @@ public class StopWatch {
} }
/** /**
* Returns the time formatted by {@link DurationFormatUtils#formatDurationHMS}. * Returns the split time formatted by {@link DurationFormatUtils#formatDurationHMS}.
* *
* @return the time formatted by {@link DurationFormatUtils#formatDurationHMS}. * @return the split time formatted by {@link DurationFormatUtils#formatDurationHMS}.
* @since 3.10 * @since 3.10
*/ */
public String formatSplitTime() { public String formatSplitTime() {
@ -259,9 +259,9 @@ public class StopWatch {
} }
/** /**
* Returns the split time formatted by {@link DurationFormatUtils#formatDurationHMS}. * Returns the time formatted by {@link DurationFormatUtils#formatDurationHMS}.
* *
* @return the split time formatted by {@link DurationFormatUtils#formatDurationHMS}. * @return the time formatted by {@link DurationFormatUtils#formatDurationHMS}.
* @since 3.10 * @since 3.10
*/ */
public String formatTime() { public String formatTime() {