Skip to content

Commit f893e07

Browse files
liannacasperliannacasper
authored
Fix CLDC11 javadoc warnings for malformed tags and references (#4705)
1 parent b601287 commit f893e07

12 files changed

Lines changed: 27 additions & 45 deletions

‎Ports/CLDC11/src/java/text/DateFormat.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public class DateFormat extends Format {
6868

6969
/// Format a given object.
7070
///
71-
/// @obj object to be formatted.
71+
/// Parameter `obj`: object to be formatted.
7272
///
7373
/// #### Returns
7474
///

‎Ports/CLDC11/src/java/util/AbstractMap.java‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,8 @@ public abstract class AbstractMap<K, V> implements Map<K, V> {
3434

3535
/// An immutable key-value mapping.
3636
///
37-
/// @param
38-
/// the type of key
39-
/// @param
40-
/// the type of value
37+
/// Type parameter `K`: the type of key
38+
/// Type parameter `V`: the type of value
4139
///
4240
/// #### Since
4341
///
@@ -157,10 +155,8 @@ public String toString() {
157155

158156
/// A key-value mapping.
159157
///
160-
/// @param
161-
/// the type of key
162-
/// @param
163-
/// the type of value
158+
/// Type parameter `K`: the type of key
159+
/// Type parameter `V`: the type of value
164160
///
165161
/// #### Since
166162
///

‎Ports/CLDC11/src/java/util/AbstractQueue.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
/// that they throw exceptions to indicate some error instead of returning true
2323
/// or false.
2424
///
25-
/// @param
26-
/// the type of the element in the collection.
25+
/// Type parameter `E`: the type of the element in the collection.
2726
public abstract class AbstractQueue<E> extends AbstractCollection<E> implements
2827
Queue<E> {
2928

‎Ports/CLDC11/src/java/util/ArrayDeque.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@
2424
///
2525
/// All optional operations are supported, and the elements can be any objects.
2626
///
27-
/// @param
28-
/// the type of elements in this collection
27+
/// Type parameter `E`: the type of elements in this collection
2928
///
3029
/// #### Since
3130
///

‎Ports/CLDC11/src/java/util/Arrays.java‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -277,8 +277,7 @@ public static int binarySearch(Object[] array, Object object) {
277277
/// Performs a binary search for the specified element in the specified
278278
/// sorted array using the Comparator to compare elements.
279279
///
280-
/// @param
281-
/// type of object
280+
/// Type parameter `T`: type of object
282281
///
283282
/// #### Parameters
284283
///
@@ -726,8 +725,7 @@ public static int binarySearch(Object[] array, int startIndex,
726725
/// Performs a binary search for the specified element in a part of the
727726
/// specified sorted array using the Comparator to compare elements.
728727
///
729-
/// @param
730-
/// type of object
728+
/// Type parameter `T`: type of object
731729
///
732730
/// #### Parameters
733731
///
@@ -3865,7 +3863,7 @@ private static boolean deepToStringImplContains(Object[] origArrays,
38653863

38663864
/// Copies elements in original array to a new array, from index
38673865
/// start(inclusive) to end(exclusive). The first element (if any) in the new
3868-
/// array is original[from], and other elements in the new array are in the
3866+
/// array is original[`from`], and other elements in the new array are in the
38693867
/// original order. The padding value whose index is bigger than or equal to
38703868
/// original.length - start is false.
38713869
///
@@ -3908,7 +3906,7 @@ public static boolean[] copyOfRange(boolean[] original, int start, int end) {
39083906

39093907
/// Copies elements in original array to a new array, from index
39103908
/// start(inclusive) to end(exclusive). The first element (if any) in the new
3911-
/// array is original[from], and other elements in the new array are in the
3909+
/// array is original[`from`], and other elements in the new array are in the
39123910
/// original order. The padding value whose index is bigger than or equal to
39133911
/// original.length - start is (byte)0.
39143912
///
@@ -3951,7 +3949,7 @@ public static byte[] copyOfRange(byte[] original, int start, int end) {
39513949

39523950
/// Copies elements in original array to a new array, from index
39533951
/// start(inclusive) to end(exclusive). The first element (if any) in the new
3954-
/// array is original[from], and other elements in the new array are in the
3952+
/// array is original[`from`], and other elements in the new array are in the
39553953
/// original order. The padding value whose index is bigger than or equal to
39563954
/// original.length - start is '\\u000'.
39573955
///
@@ -3994,7 +3992,7 @@ public static char[] copyOfRange(char[] original, int start, int end) {
39943992

39953993
/// Copies elements in original array to a new array, from index
39963994
/// start(inclusive) to end(exclusive). The first element (if any) in the new
3997-
/// array is original[from], and other elements in the new array are in the
3995+
/// array is original[`from`], and other elements in the new array are in the
39983996
/// original order. The padding value whose index is bigger than or equal to
39993997
/// original.length - start is 0d.
40003998
///
@@ -4037,7 +4035,7 @@ public static double[] copyOfRange(double[] original, int start, int end) {
40374035

40384036
/// Copies elements in original array to a new array, from index
40394037
/// start(inclusive) to end(exclusive). The first element (if any) in the new
4040-
/// array is original[from], and other elements in the new array are in the
4038+
/// array is original[`from`], and other elements in the new array are in the
40414039
/// original order. The padding value whose index is bigger than or equal to
40424040
/// original.length - start is 0f.
40434041
///
@@ -4080,7 +4078,7 @@ public static float[] copyOfRange(float[] original, int start, int end) {
40804078

40814079
/// Copies elements in original array to a new array, from index
40824080
/// start(inclusive) to end(exclusive). The first element (if any) in the new
4083-
/// array is original[from], and other elements in the new array are in the
4081+
/// array is original[`from`], and other elements in the new array are in the
40844082
/// original order. The padding value whose index is bigger than or equal to
40854083
/// original.length - start is 0.
40864084
///
@@ -4123,7 +4121,7 @@ public static int[] copyOfRange(int[] original, int start, int end) {
41234121

41244122
/// Copies elements in original array to a new array, from index
41254123
/// start(inclusive) to end(exclusive). The first element (if any) in the new
4126-
/// array is original[from], and other elements in the new array are in the
4124+
/// array is original[`from`], and other elements in the new array are in the
41274125
/// original order. The padding value whose index is bigger than or equal to
41284126
/// original.length - start is 0L.
41294127
///
@@ -4166,7 +4164,7 @@ public static long[] copyOfRange(long[] original, int start, int end) {
41664164

41674165
/// Copies elements in original array to a new array, from index
41684166
/// start(inclusive) to end(exclusive). The first element (if any) in the new
4169-
/// array is original[from], and other elements in the new array are in the
4167+
/// array is original[`from`], and other elements in the new array are in the
41704168
/// original order. The padding value whose index is bigger than or equal to
41714169
/// original.length - start is (short)0.
41724170
///

‎Ports/CLDC11/src/java/util/Collections.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2665,8 +2665,7 @@ static <E> E checkType(E obj, Class<? extends E> type) {
26652665
/// Answers a set backed by a map. And the map must be empty when this method
26662666
/// is called.
26672667
///
2668-
/// @param
2669-
/// type of elements in set
2668+
/// Type parameter `E`: type of elements in set
26702669
///
26712670
/// #### Parameters
26722671
///
@@ -2693,8 +2692,7 @@ public static <E> Set<E> newSetFromMap(Map<E, Boolean> map) {
26932692
/// Answers a LIFO Queue as a view of a Deque. Methods in the returned Queue
26942693
/// need to be re-written to implement the LIFO feature.
26952694
///
2696-
/// @param
2697-
/// type of elements
2695+
/// Type parameter `T`: type of elements
26982696
///
26992697
/// #### Parameters
27002698
///

‎Ports/CLDC11/src/java/util/Deque.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@
3232
/// A deque can also remove interior elements by removeFirstOccurrence and
3333
/// removeLastOccurrence methods. A deque can not access elements by index.
3434
///
35-
/// @param
36-
/// the type of elements in this collection
35+
/// Type parameter `E`: the type of elements in this collection
3736
///
3837
/// #### Since
3938
///

‎Ports/CLDC11/src/java/util/Iterator.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@
2626
/// `hasNext()` may throw a `ConcurrentModificationException`.
2727
/// Iterators with this behavior are called fail-fast iterators.
2828
///
29-
/// @param
30-
/// the type of object returned by the iterator.
29+
/// Type parameter `E`: the type of object returned by the iterator.
3130
public interface Iterator<E> {
3231
/// Returns whether there are more elements to iterate, i.e. whether the
3332
/// iterator is positioned in front of an element.

‎Ports/CLDC11/src/java/util/NavigableMap.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@
1919
/// NavigableMap is a SortedMap with navigation methods answering the closest
2020
/// matches for specified item.
2121
///
22-
/// @param
23-
/// the type of key
24-
/// @param
25-
/// the type of value
22+
/// Type parameter `K`: the type of key
23+
/// Type parameter `V`: the type of value
2624
///
2725
/// #### Since
2826
///

‎Ports/CLDC11/src/java/util/NavigableSet.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@
2020
/// NavigableSet is a SortedSet with navigation methods answering the closest
2121
/// matches for specified item.
2222
///
23-
/// @param
24-
/// the type of element
23+
/// Type parameter `E`: the type of element
2524
///
2625
/// #### Since
2726
///

0 commit comments

Comments
 (0)