[Java] Improved javadoc.

Author: mjpt777

aeron-client/src/main/java/io/aeron/Aeron.java

@@ -1188,6 +1188,8 @@ public Context driverTimeoutMs(final long value)
 
         /**
          * Set the timeout between service calls the to {@link ClientConductor} duty cycles in nanoseconds.
+         * <p>
+         * <b>Note:</b> the method is used for testing only.
          *
          * @param interServiceTimeout the timeout (ns) between service calls the to {@link ClientConductor} duty cycle.
          * @return this for a fluent API.
@@ -1201,11 +1203,11 @@ Context interServiceTimeoutNs(final long interServiceTimeout)
         /**
          * Return the timeout between service calls to the duty cycle for the client.
          * <p>
-         * When exceeded, {@link #errorHandler()} will be called and the active {@link Publication}s and {@link Image}s
-         * closed.
+         * When exceeded, {@link #errorHandler()} will be called and the active {@link Publication}s, {@link Image}s,
+         * and {@link Counter}s will be closed.
          * <p>
          * This value is controlled by the driver and included in the CnC file. It can be configured by adjusting
-         * the {@code aeron.client.liveness.timeout} property on the media driver.
+         * the {@code aeron.client.liveness.timeout} property set on the media driver.
          *
          * @return the timeout in nanoseconds between service calls as an allowed maximum.
          */

aeron-client/src/main/java/io/aeron/CommonContext.java

@@ -292,6 +292,9 @@ public static InferableBoolean parse(final String value)
      */
     private static final AtomicIntegerFieldUpdater<CommonContext> IS_CONCLUDED_UPDATER = newUpdater(
         CommonContext.class, "isConcluded");
+
+    private static final Map<String, Boolean> DEBUG_FIELDS_SEEN = new ConcurrentHashMap<>();
+
     private volatile int isConcluded;
 
     private long driverTimeoutMs = DRIVER_TIMEOUT_MS;
@@ -529,7 +532,6 @@ public long driverTimeoutMs()
         return checkDebugTimeout(driverTimeoutMs, TimeUnit.MILLISECONDS);
     }
 
-    private static final Map<String, Boolean> DEBUG_FIELDS_SEEN = new ConcurrentHashMap<>();
     /**
      * Override the supplied timeout with the debug value if it has been set and we are in debug mode.
      *

aeron-client/src/main/java/io/aeron/exceptions/ConductorServiceTimeoutException.java

@@ -17,6 +17,9 @@
 
 /**
  * A timeout has occurred between service calls for the client conductor.
+ * <p>
+ * This is likely to occur due to GC or resource starvation where the client conductor thread has not being able to
+ * run within the {@code aeron.client.liveness.timeout} property set on the media driver.
  */
 public class ConductorServiceTimeoutException extends TimeoutException
 {

aeron-driver/src/main/java/io/aeron/driver/Configuration.java

@@ -328,7 +328,9 @@ public class Configuration
     public static final long PUBLICATION_CONNECTION_TIMEOUT_DEFAULT_NS = TimeUnit.SECONDS.toNanos(5);
 
     /**
-     * Property name for if spy subscriptions simulate a connection.
+     * Property name for if spy subscriptions simulate a connection to a network publication.
+     * <p>
+     * If true then this will override the min group size of the min and tagged flow control strategies.
      */
     public static final String SPIES_SIMULATE_CONNECTION_PROP_NAME = "aeron.spies.simulate.connection";
 

aeron-driver/src/main/java/io/aeron/driver/MediaDriver.java

@@ -1382,6 +1382,8 @@ public Context publicationConnectionTimeoutNs(final long timeoutNs)
 
         /**
          * Does a spy subscription simulate a connection to a network publication.
+         * <p>
+         * If true then this will override the min group size of the min and tagged flow control strategies.
          *
          * @return true if a spy subscription should simulate a connection to a network publication.
          * @see Configuration#SPIES_SIMULATE_CONNECTION_PROP_NAME
@@ -1393,6 +1395,8 @@ public boolean spiesSimulateConnection()
 
         /**
          * Does a spy subscription simulate a connection to a network publication.
+         * <p>
+         * If true then this will override the min group size of the min and tagged flow control strategies.
          *
          * @param spiesSimulateConnection true if a spy subscription simulates a connection to a network publication.
          * @return this for a fluent API.