Merge pull request #8 from nats-io/doc2

fixed doc

Author: scottf

.github/workflows/pr.yml

@@ -19,3 +19,6 @@ jobs:
         uses: actions/checkout@v2
       - name: Build and Test
         run: chmod +x gradlew && ./gradlew test
+      - name: Check Docs
+        if: ${{ success() }}
+        run: ./gradlew javadoc

src/main/java/nats/io/NatsRunnerUtils.java

@@ -33,7 +33,7 @@ public static String getURIForPort(int port) {
     /**
      * Get a port number automatically allocated by the system, typically from an ephemeral port range.
      * @return the port number
-     * @throws IOException
+     * @throws IOException if there is a problem getting a port
      */
     public static int nextPort() throws IOException {
         try (ServerSocket socket = new ServerSocket(0)) {

src/main/java/nats/io/NatsServerRunner.java

@@ -93,7 +93,7 @@ public NatsServerRunner(boolean debug, boolean jetstream) throws IOException {
      * <li>no custom args</li>
      * </ul>
      * and these options:
-     * @param port the port to start on or <=0 to use an automatically allocated port
+     * @param port the port to start on or &lt;=0 to use an automatically allocated port
      * @param debug whether to start the server with the -DV flags
      * @throws IOException thrown when the server cannot start
      */
@@ -109,7 +109,7 @@ public NatsServerRunner(int port, boolean debug) throws IOException {
      * <li>no custom args</li>
      * </ul>
      * and these options:
-     * @param port the port to start on or <=0 to use an automatically allocated port
+     * @param port the port to start on or &lt;=0 to use an automatically allocated port
      * @param debug whether to start the server with the -DV flags
      * @param jetstream whether to enable JetStream
      * @throws IOException thrown when the server cannot start
@@ -159,7 +159,7 @@ public NatsServerRunner(String configFilePath, boolean debug, boolean jetstream)
      * <li>no custom args</li>
      * </ul>
      * and these options:
-     * @param port the port to start on or <=0 to use an automatically allocated port
+     * @param port the port to start on or &lt;=0 to use an automatically allocated port
      * @param debug whether to start the server with the -DV flags
      * @param configFilePath path to a custom config file
      * @param configInserts an array of custom lines to add to the config file
@@ -177,7 +177,7 @@ public NatsServerRunner(String configFilePath, String[] configInserts, int port,
      * <li>no custom args</li>
      * </ul>
      * and these options:
-     * @param port the port to start on or <=0 to use an automatically allocated port
+     * @param port the port to start on or &lt;=0 to use an automatically allocated port
      * @param debug whether to start the server with the -DV flags
      * @param configFilePath path to a custom config file
      * @throws IOException thrown when the server cannot start
@@ -212,7 +212,7 @@ public NatsServerRunner(String[] customArgs, boolean debug) throws IOException {
      * </ul>
      * and these options:
      * @param customArgs any custom args to add to the command line
-     * @param port the port to start on or <=0 to use an automatically allocated port
+     * @param port the port to start on or &lt;=0 to use an automatically allocated port
      * @param debug whether to start the server with the -DV flags
      * @throws IOException thrown when the server cannot start
      */
@@ -223,7 +223,7 @@ public NatsServerRunner(String[] customArgs, int port, boolean debug) throws IOE
     /**
      * Construct and start the Nats Server runner with options
      *
-     * @param port the port to start on or <=0 to use an automatically allocated port
+     * @param port the port to start on or &lt;=0 to use an automatically allocated port
      * @param debug whether to start the server with the -DV flags
      * @param jetstream whether to enable JetStream
      * @param configFilePath path to a custom config file