Skip to content

Commit e2328c2

Browse files
rahulsomRahul Somasunderam
andauthored
docs: Add missing javadoc (#121)
This shows up as a warning during the build. Though the method is deprecated, it's worth documenting it. See: jenkinsci/gradle-jpi-plugin#241 (comment) Co-authored-by: Rahul Somasunderam <rahulsom@noreply.github.com>
1 parent 6a0e490 commit e2328c2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/main/java/hudson/util/VersionNumber.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -545,6 +545,11 @@ public boolean isNewerThanOrEqualTo(VersionNumber rhs) {
545545
}
546546

547547
/**
548+
* Returns a digit (numeric component) by its position. Once a non-numeric component is found all remaining components
549+
* are also considered non-numeric by this method.
550+
*
551+
* @param idx Digit position we want to retrieve starting by 0.
552+
* @return The digit or -1 in case the position does not correspond with a digit.
548553
* @deprecated see {@link #getDigitAt(int)}
549554
*/
550555
@Deprecated

0 commit comments

Comments
 (0)