cleanup of javadoc for core packages (rsocket#368)

yschimke · web-flow · commit 6b2c33608334 · 2017-08-12T08:38:42.000+01:00
diff --git a/rsocket-core/src/main/java/io/rsocket/Payload.java b/rsocket-core/src/main/java/io/rsocket/Payload.java
@@ -22,6 +22,8 @@
 public interface Payload {
   /**
    * Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
+   *
+   * @return whether payload has non-null (possibly empty) metadata
    */
   boolean hasMetadata();
 
diff --git a/rsocket-core/src/main/java/io/rsocket/RSocketFactory.java b/rsocket-core/src/main/java/io/rsocket/RSocketFactory.java
@@ -36,12 +36,20 @@
 
 /** Factory for creating RSocket clients and servers. */
 public interface RSocketFactory {
-  /** Creates a factory that establishes client connections to other RSockets */
+  /**
+   * Creates a factory that establishes client connections to other RSockets.
+   *
+   * @return a client factory
+   */
   static ClientRSocketFactory connect() {
     return new ClientRSocketFactory();
   }
 
-  /** Creates a factory that receives server connections from client RSockets */
+  /**
+   * Creates a factory that receives server connections from client RSockets.
+   *
+   * @return a server factory.
+   */
   static ServerRSocketFactory receive() {
     return new ServerRSocketFactory();
   }
diff --git a/rsocket-core/src/main/java/io/rsocket/internal/ClientServerInputMultiplexer.java b/rsocket-core/src/main/java/io/rsocket/internal/ClientServerInputMultiplexer.java
@@ -40,8 +40,6 @@
  * <p>The only way to differentiate these two frames is determining whether the stream Id is odd or
  * even. Even IDs are for the streams initiated by server and odds are for streams initiated by the
  * client.
- *
- * <p>
  */
 public class ClientServerInputMultiplexer {
   private static final Logger LOGGER = LoggerFactory.getLogger("io.rsocket.FrameLogger");
diff --git a/rsocket-core/src/main/java/io/rsocket/lease/Lease.java b/rsocket-core/src/main/java/io/rsocket/lease/Lease.java
@@ -63,6 +63,7 @@ default boolean isExpired() {
   /**
    * Checks if the lease is expired for the passed {@code now}.
    *
+   *  @param now current time in millis.
    * @return {@code true} if the lease has expired.
    */
   default boolean isExpired(long now) {
diff --git a/rsocket-load-balancer/src/main/java/io/rsocket/stat/Quantile.java b/rsocket-load-balancer/src/main/java/io/rsocket/stat/Quantile.java
@@ -22,7 +22,7 @@ public interface Quantile {
   /**
    * Insert a data point `x` in the quantile estimator.
    *
-   * @param x
+   * @param x the data point to add.
    */
   public void insert(double x);
 }
diff --git a/rsocket-transport-netty/src/main/java/io/rsocket/transport/netty/RSocketLengthCodec.java b/rsocket-transport-netty/src/main/java/io/rsocket/transport/netty/RSocketLengthCodec.java
@@ -31,7 +31,10 @@ public RSocketLengthCodec() {
   /**
    * Simplified non-netty focused decode usage.
    *
+   * @param in the input buffer to read data from.
+   * @return decoded buffer or null is none available.
    * @see #decode(ChannelHandlerContext, ByteBuf)
+   * @throws Exception if any error happens.
    */
   public Object decode(ByteBuf in) throws Exception {
     return decode(null, in);
diff --git a/rsocket-transport-netty/src/main/java/io/rsocket/transport/netty/server/NettyContextCloseable.java b/rsocket-transport-netty/src/main/java/io/rsocket/transport/netty/server/NettyContextCloseable.java
@@ -51,7 +51,11 @@ public Mono<Void> onClose() {
     return onClose;
   }
 
-  /** @see NettyContext#address() */
+  /**
+   * @see NettyContext#address()
+   *
+   * @return socket address.
+   */
   public InetSocketAddress address() {
     return context.address();
   }

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ default boolean isExpired() {`
`63`	`63`	`/**`
`64`	`64`	`* Checks if the lease is expired for the passed {@code now}.`
`65`	`65`	`*`
	`66`	`+ * @param now current time in millis.`
`66`	`67`	`* @return {@code true} if the lease has expired.`
`67`	`68`	`*/`
`68`	`69`	`default boolean isExpired(long now) {`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public interface Quantile {`
`22`	`22`	`/**`
`23`	`23`	* Insert a data point `x` in the quantile estimator.
`24`	`24`	`*`
`25`		`- * @param x`
	`25`	`+ * @param x the data point to add.`
`26`	`26`	`*/`
`27`	`27`	`public void insert(double x);`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,11 @@ public Mono<Void> onClose() {`
`51`	`51`	`return onClose;`
`52`	`52`	`}`
`53`	`53`
`54`		`- /** @see NettyContext#address() */`
	`54`	`+ /**`
	`55`	`+ * @see NettyContext#address()`
	`56`	`+ *`
	`57`	`+ * @return socket address.`
	`58`	`+ */`
`55`	`59`	`public InetSocketAddress address() {`
`56`	`60`	`return context.address();`
`57`	`61`	`}`