Skip to content

Commit 879d274

Browse files
committed
Javadoc: Empty Javadoc line before the 1st tag.
1 parent 8831944 commit 879d274

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+84
-0
lines changed

src/main/java/org/apache/commons/collections4/CollectionUtils.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ public class CollectionUtils {
5858

5959
/**
6060
* Helper class to easily access cardinality properties of two collections.
61+
*
6162
* @param <O> the element type
6263
*/
6364
private static class CardinalityHelper<O> {
@@ -169,6 +170,7 @@ public int hashCode() {
169170

170171
/**
171172
* Helper class for set-related operations, for example union, subtract, intersection.
173+
*
172174
* @param <O> the element type
173175
*/
174176
private static final class SetOperationCardinalityHelper<O> extends CardinalityHelper<O> implements Iterable<O> {
@@ -181,6 +183,7 @@ private static final class SetOperationCardinalityHelper<O> extends CardinalityH
181183

182184
/**
183185
* Create a new set operation helper from the two collections.
186+
*
184187
* @param a the first collection
185188
* @param b the second collection
186189
*/
@@ -200,6 +203,7 @@ public Iterator<O> iterator() {
200203

201204
/**
202205
* Returns the resulting collection.
206+
*
203207
* @return the result
204208
*/
205209
public Collection<O> list() {
@@ -208,6 +212,7 @@ public Collection<O> list() {
208212

209213
/**
210214
* Add the object {@code count} times to the result collection.
215+
*
211216
* @param obj the object to add
212217
* @param count the count
213218
*/
@@ -373,6 +378,7 @@ public static <O> int cardinality(final O obj, final Iterable<? super O> collect
373378

374379
/**
375380
* Ensures an index is not negative.
381+
*
376382
* @param index the index to check.
377383
* @throws IndexOutOfBoundsException if the index is negative.
378384
*/

src/main/java/org/apache/commons/collections4/FluentIterable.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ public static <T> FluentIterable<T> of(final T... elements) {
138138

139139
/**
140140
* Create a new FluentIterable by wrapping the provided iterable.
141+
*
141142
* @param iterable the iterable to wrap
142143
*/
143144
private FluentIterable(final Iterable<E> iterable) {

src/main/java/org/apache/commons/collections4/IteratorUtils.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -759,6 +759,7 @@ private static <E> E find(final Iterator<E> iterator, final Predicate<? super E>
759759
* The Iterator is advanced to {@code 0} (or to the end, if
760760
* {@code 0} exceeds the number of entries) as a side effect of this method.
761761
* </p>
762+
*
762763
* @param <E> the type of object in the {@link Iterator}
763764
* @param iterator the iterator to get a value from
764765
* @return the first object

src/main/java/org/apache/commons/collections4/ListUtils.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ public void visitKeepCommand(final E object) {
9696

9797
/**
9898
* Provides a partition view on a {@link List}.
99+
*
99100
* @since 4.0
100101
*/
101102
private static final class Partition<T> extends AbstractList<List<T>> {

src/main/java/org/apache/commons/collections4/SetUtils.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ public <S extends Set<E>> void copyInto(final S set) {
8181
/**
8282
* Return an iterator for this view; the returned iterator is
8383
* not required to be unmodifiable.
84+
*
8485
* @return a new iterator for this view
8586
*/
8687
protected abstract Iterator<E> createIterator();
@@ -644,6 +645,7 @@ public static <E> SortedSet<E> unmodifiableNavigableSet(final NavigableSet<E> se
644645
/**
645646
* Creates an unmodifiable set from the given items. If the passed var-args argument is {@code
646647
* null}, then the method returns {@code null}.
648+
*
647649
* @param <E> the element type
648650
* @param items the elements that make up the new set
649651
* @return a set

src/main/java/org/apache/commons/collections4/SortedBidiMap.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public interface SortedBidiMap<K, V> extends OrderedBidiMap<K, V>, SortedMap<K,
5656

5757
/**
5858
* Gets the comparator used for the values in the value-to-key map aspect.
59+
*
5960
* @return Comparator&lt;? super V&gt;
6061
*/
6162
Comparator<? super V> valueComparator();

src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ public abstract class AbstractBagDecorator<E>
3838

3939
/**
4040
* Constructor only used in deserialization, do not use otherwise.
41+
*
4142
* @since 3.1
4243
*/
4344
protected AbstractBagDecorator() {

src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ protected static class MutableInteger {
121121

122122
/**
123123
* Constructs a new instance.
124+
*
124125
* @param value the initial value
125126
*/
126127
MutableInteger(final int value) {
@@ -479,6 +480,7 @@ public boolean removeAll(final Collection<?> coll) {
479480
/**
480481
* Remove any members of the bag that are not in the given bag, respecting
481482
* cardinality.
483+
*
482484
* @see #retainAll(Collection)
483485
* @param other the bag to retain
484486
* @return {@code true} if this call changed the collection

src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ public abstract class AbstractSortedBagDecorator<E>
3737

3838
/**
3939
* Constructor only used in deserialization, do not use otherwise.
40+
*
4041
* @since 3.1
4142
*/
4243
protected AbstractSortedBagDecorator() {

src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ final class SynchronizedBagSet extends SynchronizedCollection<E> implements Set<
4646

4747
/**
4848
* Constructs a new instance.
49+
*
4950
* @param set the set to decorate
5051
* @param lock the lock to use, shared with the bag
5152
*/

0 commit comments

Comments
 (0)