tweak javadoc

Signed-off-by: Jerry Shea <jerry.shea@chronicle.software>

src/main/java/net/openhft/chronicle/network/NetworkStatsListener.java

@@ -43,15 +43,32 @@ static <N extends NetworkContext<N>> void notifyHostPort(@Nullable final Chronic
 
     void networkContext(N networkContext);
 
+    /**
+     * Called periodically (see tcp.event.monitor.secs system property) with summary network stats
+     *
+     * @param writeBps write Bytes/sec
+     * @param readBps read Bytes/sec
+     * @param socketPollCountPerSecond socket poll count/sec
+     */
     void onNetworkStats(long writeBps, long readBps, long socketPollCountPerSecond);
 
     void onHostPort(String hostName, int port);
 
+    /**
+     * Notification of individual round trip latency, called only if acknowledge enabled
+     *
+     * @param nanosecondLatency latency
+     */
     void onRoundTripLatency(long nanosecondLatency);
 
     default void procPrefix(String procPrefix) {
     }
 
+    /**
+     * Notification of individual message one way trip latency (requires sender's clock to be synchronised with receiver's)
+     *
+     * @param nanosecondLatency latency
+     */
     default void onReceiveLatency(long nanosecondLatency) {
     }
 }

src/main/java/net/openhft/chronicle/network/api/NetworkStats.java

@@ -59,6 +59,11 @@ public NetworkStats userId(String userId) {
         return this;
     }
 
+    /**
+     * Bytes written per second
+     *
+     * @return write Bytes/sec
+     */
     public long writeBps() {
         return writeBps;
     }
@@ -68,6 +73,11 @@ public NetworkStats writeBps(long writeBps) {
         return this;
     }
 
+    /**
+     * Bytes read per second
+     *
+     * @return read Bytes/sec
+     */
     public long readBps() {
         return readBps;
     }
@@ -104,6 +114,11 @@ public NetworkStats index(long index) {
         return this;
     }
 
+    /**
+     * Timestamp of last update to this, from {@link System#currentTimeMillis()}
+     *
+     * @return timestamp in millis
+     */
     public long timestamp() {
         return timestamp;
     }
@@ -113,6 +128,11 @@ public NetworkStats timestamp(long timestamp) {
         return this;
     }
 
+    /**
+     * Socket polls per second
+     *
+     * @return socket polls/sec
+     */
     public long socketPollRate() {
         return socketPollRate;
     }
@@ -122,6 +142,11 @@ public NetworkStats socketPollRate(long socketPollRate) {
         return this;
     }
 
+    /**
+     * Local identifier (hostId)
+     *
+     * @return local hostId
+     */
     public int localIdentifier() {
         return localIdentifier;
     }
@@ -212,6 +237,11 @@ public NetworkStats clientId(UUID clientId) {
         return this;
     }
 
+    /**
+     * Remote host name as determined at connection time
+     *
+     * @return remote host name
+     */
     public String remoteHostName() {
         return remoteHostName;
     }
@@ -221,6 +251,11 @@ public NetworkStats remoteHostName(String remoteHostName) {
         return this;
     }
 
+    /**
+     * Remote port as determined at connection time
+     *
+     * @return remote port
+     */
     public int remotePort() {
         return remotePort;
     }