Skip to content

Commit 03bbf4a

Browse files
committed
Fix malformed Javadoc comments
1 parent 21e8d1b commit 03bbf4a

File tree

37 files changed

+465
-465
lines changed

37 files changed

+465
-465
lines changed

commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/IndexSupport.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -252,10 +252,10 @@ static int countIndices(UpdatingInterval keys, int n) {
252252
* <p>The sub-range is defined to be out of bounds if any of the following
253253
* inequalities is true:
254254
* <ul>
255-
* <li>{@code fromIndex < 0}
256-
* <li>{@code fromIndex > toIndex}
257-
* <li>{@code toIndex > length}
258-
* <li>{@code length < 0}, which is implied from the former inequalities
255+
* <li>{@code fromIndex < 0}</li>
256+
* <li>{@code fromIndex > toIndex}</li>
257+
* <li>{@code toIndex > length}</li>
258+
* <li>{@code length < 0}, which is implied from the former inequalities</li>
259259
* </ul>
260260
*
261261
* @param fromIndex Lower-bound (inclusive) of the sub-range.

commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/KeyUpdatingInterval.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,10 @@ int size() {
143143
* <p>This is similar to using {@link java.util.Arrays#binarySearch(int[], int, int, int)
144144
* Arrays.binarySearch}. The method differs in:
145145
* <ul>
146-
* <li>use of an inclusive upper bound;
147-
* <li>returning the closest index with a value below {@code key} if no match was not found;
146+
* <li>use of an inclusive upper bound;</li>
147+
* <li>returning the closest index with a value below {@code key} if no match was not found;</li>
148148
* <li>performing no range checks: it is assumed {@code left <= right} and they are valid
149-
* indices into the array.
149+
* indices into the array.</li>
150150
* </ul>
151151
*
152152
* <p>An equivalent use of binary search is:

commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/QuickSelect.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,10 +1276,10 @@ static void dualPivotQuickSelect(double[] a, int left, int right, UpdatingInterv
12761276
* }</pre>
12771277
*
12781278
* <ul>
1279-
* <li>k0: lower pivot1 point
1280-
* <li>k1: upper pivot1 point (inclusive)
1281-
* <li>k2: lower pivot2 point
1282-
* <li>k3: upper pivot2 point (inclusive)
1279+
* <li>k0: lower pivot1 point</li>
1280+
* <li>k1: upper pivot1 point (inclusive)</li>
1281+
* <li>k2: lower pivot2 point</li>
1282+
* <li>k3: upper pivot2 point (inclusive)</li>
12831283
* </ul>
12841284
*
12851285
* <p>Bounds are set so {@code i < k0}, {@code i > k3} and {@code k1 < i < k2} are
@@ -2535,10 +2535,10 @@ static void dualPivotQuickSelect(int[] a, int left, int right, UpdatingInterval
25352535
* }</pre>
25362536
*
25372537
* <ul>
2538-
* <li>k0: lower pivot1 point
2539-
* <li>k1: upper pivot1 point (inclusive)
2540-
* <li>k2: lower pivot2 point
2541-
* <li>k3: upper pivot2 point (inclusive)
2538+
* <li>k0: lower pivot1 point</li>
2539+
* <li>k1: upper pivot1 point (inclusive)</li>
2540+
* <li>k2: lower pivot2 point</li>
2541+
* <li>k3: upper pivot2 point (inclusive)</li>
25422542
* </ul>
25432543
*
25442544
* <p>Bounds are set so {@code i < k0}, {@code i > k3} and {@code k1 < i < k2} are

commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/Selection.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -91,29 +91,29 @@
9191
* <ol>
9292
* <li>Hoare (1961)
9393
* Algorithm 65: Find
94-
* <a href="https://doi.org/10.1145%2F366622.366647">Comm. ACM. 4 (7): 321–322</a>
94+
* <a href="https://doi.org/10.1145%2F366622.366647">Comm. ACM. 4 (7): 321–322</a></li>
9595
* <li>Musser (1999)
9696
* Introspective Sorting and Selection Algorithms
9797
* <a href="https://doi.org/10.1002/(SICI)1097-024X(199708)27:8%3C983::AID-SPE117%3E3.0.CO;2-%23">
98-
* Software: Practice and Experience 27, 983-993.</a>
98+
* Software: Practice and Experience 27, 983-993.</a></li>
9999
* <li>Floyd and Rivest (1975)
100100
* Algorithm 489: The Algorithm SELECT—for Finding the ith Smallest of n elements.
101-
* Comm. ACM. 18 (3): 173.
101+
* Comm. ACM. 18 (3): 173.</li>
102102
* <li>Kiwiel (2005)
103103
* On Floyd and Rivest's SELECT algorithm.
104-
* Theoretical Computer Science 347, 214-238.
104+
* Theoretical Computer Science 347, 214-238.</li>
105105
* <li>Blum, Floyd, Pratt, Rivest, and Tarjan (1973)
106106
* Time bounds for selection.
107107
* <a href="https://doi.org/10.1016%2FS0022-0000%2873%2980033-9">
108-
* Journal of Computer and System Sciences. 7 (4): 448–461</a>.
108+
* Journal of Computer and System Sciences. 7 (4): 448–461</a>.</li>
109109
* <li>Alexandrescu (2016)
110110
* Fast Deterministic Selection
111-
* <a href="https://arxiv.org/abs/1606.00484">arXiv:1606.00484</a>.
112-
* <li><a href="https://en.wikipedia.org/wiki/Quickselect">Quickselect (Wikipedia)</a>
113-
* <li><a href="https://en.wikipedia.org/wiki/Introsort">Introsort (Wikipedia)</a>
114-
* <li><a href="https://en.wikipedia.org/wiki/Introselect">Introselect (Wikipedia)</a>
115-
* <li><a href="https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm">Floyd-Rivest algorithm (Wikipedia)</a>
116-
* <li><a href="https://en.wikipedia.org/wiki/Median_of_medians">Median of medians (Wikipedia)</a>
111+
* <a href="https://arxiv.org/abs/1606.00484">arXiv:1606.00484</a>.</li>
112+
* <li><a href="https://en.wikipedia.org/wiki/Quickselect">Quickselect (Wikipedia)</a></li>
113+
* <li><a href="https://en.wikipedia.org/wiki/Introsort">Introsort (Wikipedia)</a></li>
114+
* <li><a href="https://en.wikipedia.org/wiki/Introselect">Introselect (Wikipedia)</a></li>
115+
* <li><a href="https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm">Floyd-Rivest algorithm (Wikipedia)</a></li>
116+
* <li><a href="https://en.wikipedia.org/wiki/Median_of_medians">Median of medians (Wikipedia)</a></li>
117117
* </ol>
118118
*
119119
* @since 1.2

commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/UpdatingInterval.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
* <p>The interval provides the following functionality:
2323
*
2424
* <ul>
25-
* <li>Return the supported bounds of the interval {@code [left <= right]}.
26-
* <li>Update the left or right bound of the interval using an index {@code k} inside the interval.
27-
* <li>Split the interval around two indices {@code k1} and {@code k2}.
25+
* <li>Return the supported bounds of the interval {@code [left <= right]}.</li>
26+
* <li>Update the left or right bound of the interval using an index {@code k} inside the interval.</li>
27+
* <li>Split the interval around two indices {@code k1} and {@code k2}.</li>
2828
* </ul>
2929
*
3030
* <p>Note that the interval provides the supported bounds. If an search index {@code k} is

commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/Stirling.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,9 +271,9 @@ private static void checkN(int n, int k, int threshold, String msgFormat) {
271271
* Return {@code a*b/4} without intermediate overflow.
272272
* It is assumed that:
273273
* <ul>
274-
* <li>The coefficients a and b are positive
275-
* <li>The product (a*b) is an exact multiple of 4
276-
* <li>The result (a*b/4) is an exact integer that does not overflow a {@code long}
274+
* <li>The coefficients a and b are positive</li>
275+
* <li>The product (a*b) is an exact multiple of 4</li>
276+
* <li>The result (a*b/4) is an exact integer that does not overflow a {@code long}</li>
277277
* </ul>
278278
*
279279
* <p>A conditional branch is performed on the odd/even property of {@code b}.

0 commit comments

Comments
 (0)