Javadoc: Empty Javadoc line before the 1st tag.

Author: garydgregory

src/main/java/org/apache/commons/pool2/KeyedObjectPool.java

@@ -225,6 +225,7 @@ default List<K> getKeys() {
      * Gets the total number of instances currently borrowed from this pool but
      * not yet returned. Returns a negative value if this information is not
      * available.
+     *
      * @return the total number of instances currently borrowed from this pool but
      * not yet returned.
      */
@@ -244,6 +245,7 @@ default List<K> getKeys() {
     /**
      * Gets the total number of instances currently idle in this pool.
      * Returns a negative value if this information is not available.
+     *
      * @return the total number of instances currently idle in this pool.
      */
     int getNumIdle();

src/main/java/org/apache/commons/pool2/ObjectPool.java

@@ -149,6 +149,7 @@ default void addObjects(final int count) throws Exception {
     /**
      * Gets the number of instances currently borrowed from this pool. Returns
      * a negative value if this information is not available.
+     *
      * @return the number of instances currently borrowed from this pool.
      */
     int getNumActive();
@@ -158,6 +159,7 @@ default void addObjects(final int count) throws Exception {
      * considered an approximation of the number of objects that can be
      * {@link #borrowObject borrowed} without creating any new instances.
      * Returns a negative value if this information is not available.
+     *
      * @return the number of instances currently idle in this pool.
      */
     int getNumIdle();

src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java

@@ -72,6 +72,7 @@ final class EvictionIterator implements Iterator<PooledObject<T>> {
 
         /**
          * Constructs an EvictionIterator for the provided idle instance deque.
+         *
          * @param idleObjects underlying deque.
          */
         EvictionIterator(final Deque<PooledObject<T>> idleObjects) {
@@ -86,6 +87,7 @@ final class EvictionIterator implements Iterator<PooledObject<T>> {
 
         /**
          * Gets the idle object deque referenced by this iterator.
+         *
          * @return the idle object deque
          */
         public Deque<PooledObject<T>> getIdleObjects() {
@@ -459,6 +461,7 @@ String appendStats(final String string) {
 
     /**
      * Verifies that the pool is open.
+     *
      * @throws IllegalStateException if the pool is closed.
      */
     final void assertOpen() throws IllegalStateException {
@@ -476,6 +479,7 @@ final void assertOpen() throws IllegalStateException {
 
     /**
      * Creates a list of pooled objects to remove based on their state.
+     *
      * @param abandonedConfig The abandoned configuration.
      * @param allObjects PooledObject instances to consider.
      * @return a list of pooled objects to remove based on their state.
@@ -508,6 +512,7 @@ final Duration durationSince(final Instant startInstant) {
     /**
      * Tries to ensure that the configured minimum number of idle instances are
      * available in the pool.
+     *
      * @throws Exception if an error occurs creating idle instances
      */
     abstract void ensureMinIdle() throws Exception;
@@ -541,6 +546,7 @@ public final boolean getBlockWhenExhausted() {
     /**
      * Gets the total number of objects successfully borrowed from this pool over the
      * lifetime of the pool.
+     *
      * @return the borrowed object count
      */
     public final long getBorrowedCount() {
@@ -564,6 +570,7 @@ public boolean getCollectDetailedStatistics() {
     /**
      * Gets the total number of objects created for this pool over the lifetime of
      * the pool.
+     *
      * @return the created object count
      */
     public final long getCreatedCount() {
@@ -576,6 +583,7 @@ public final long getCreatedCount() {
      * deregistered when no longer used by calling the {@link #close()} method.
      * This method is provided to assist with identifying code that creates but
      * does not close it thereby creating a memory leak.
+     *
      * @return pool creation stack trace
      */
     public final String getCreationStackTrace() {
@@ -586,6 +594,7 @@ public final String getCreationStackTrace() {
      * Gets the total number of objects destroyed by this pool as a result of failing
      * validation during {@code borrowObject()} over the lifetime of the
      * pool.
+     *
      * @return validation destroyed object count
      */
     public final long getDestroyedByBorrowValidationCount() {
@@ -595,6 +604,7 @@ public final long getDestroyedByBorrowValidationCount() {
     /**
      * Gets the total number of objects destroyed by the evictor associated with this
      * pool over the lifetime of the pool.
+     *
      * @return the evictor destroyed object count
      */
     public final long getDestroyedByEvictorCount() {
@@ -604,6 +614,7 @@ public final long getDestroyedByEvictorCount() {
     /**
      * Gets the total number of objects destroyed by this pool over the lifetime of
      * the pool.
+     *
      * @return the destroyed object count
      */
     public final long getDestroyedCount() {
@@ -702,6 +713,7 @@ public final boolean getFairness() {
      * Gets the name under which the pool has been registered with the
      * platform MBean server or {@code null} if the pool has not been
      * registered.
+     *
      * @return the JMX name
      */
     public final ObjectName getJmxName() {
@@ -813,6 +825,7 @@ public final long getMaxWaitMillis() {
     /**
      * Gets the mean time objects are active for based on the last {@link
      * #MEAN_TIMING_STATS_CACHE_SIZE} objects returned to the pool.
+     *
      * @return mean time an object has been checked out from the pool among
      * recently returned objects.
      *
@@ -825,6 +838,7 @@ public final Duration getMeanActiveDuration() {
     /**
      * Gets the mean time objects are active for based on the last {@link
      * #MEAN_TIMING_STATS_CACHE_SIZE} objects returned to the pool.
+     *
      * @return mean time an object has been checked out from the pool among
      * recently returned objects.
      *
@@ -955,6 +969,7 @@ public final long getMinEvictableIdleTimeMillis() {
 
     /**
      * Gets the number of instances currently idle in this pool.
+     *
      * @return count of instances available for checkout from the pool
      */
     public abstract int getNumIdle();
@@ -1042,6 +1057,7 @@ public Duration getRemoveAbandonedTimeoutDuration() {
      * Gets the total number of objects returned to this pool over the lifetime of
      * the pool. This excludes attempts to return the same object multiple
      * times.
+     *
      * @return the returned object count
      */
     public final long getReturnedCount() {
@@ -1113,6 +1129,7 @@ public final long getSoftMinEvictableIdleTimeMillis() {
 
     /**
      * Gets the stack trace of an exception as a string.
+     *
      * @param e exception to trace
      * @return exception stack trace as a string
      */
@@ -1348,6 +1365,7 @@ final void jmxUnregister() {
 
     /**
      * Marks the object as returning to the pool.
+     *
      * @param pooledObject instance to return to the keyed pool
      */
     protected void markReturningState(final PooledObject<T> pooledObject) {

src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java

@@ -142,6 +142,7 @@ public long getActiveTimeMillis() {
 
     /**
      * Gets the number of times this object has been borrowed.
+     *
      * @return The number of times this object has been borrowed.
      * @since 2.1
      */
@@ -237,6 +238,7 @@ public T getObject() {
 
     /**
      * Gets the state of this object.
+     *
      * @return state
      */
     @Override

src/main/java/org/apache/commons/pool2/impl/EvictionTimer.java

@@ -99,6 +99,7 @@ public void run() {
     /**
      * Runnable that runs the referent of a weak reference. When the referent is no
      * no longer reachable, run is no-op.
+     *
      * @param <R> The kind of Runnable.
      */
     private static final class WeakRunner<R extends Runnable> implements Runnable {

src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java

@@ -125,6 +125,7 @@ private static final class ObjectDeque<S> {
 
         /**
          * Constructs a new ObjectDeque with the given fairness policy.
+         *
          * @param fairness true means client threads waiting to borrow / return instances
          * will be served as if waiting in a FIFO queue.
          */
@@ -249,6 +250,7 @@ public String toString() {
     /**
      * Constructs a new {@code GenericKeyedObjectPool} using defaults from
      * {@link GenericKeyedObjectPoolConfig}.
+     *
      * @param factory the factory to be used to create entries
      */
     public GenericKeyedObjectPool(final KeyedPooledObjectFactory<K, T> factory) {

src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java

@@ -329,6 +329,7 @@ private static final class Node<E> {
     /**
      * Creates a {@code LinkedBlockingDeque} with a capacity of
      * {@link Integer#MAX_VALUE} and the given fairness policy.
+     *
      * @param fairness true means threads waiting on the deque should be served
      * as if waiting in a FIFO request queue
      */

src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java

@@ -353,6 +353,7 @@ private void pruneClearedReferences() {
 
     /**
      * Clears cleared references from iterator's collection
+     *
      * @param iterator iterator over idle/allReferences
      */
     private void removeClearedReferences(final Iterator<PooledSoftReference<T>> iterator) {