Add scripts/javadoc.sh lint/build script

.github/workflows/test.yml

@@ -11,11 +11,13 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '8'
+          java-version: '11'
       - name: Install Clojure tools
         uses: DeLaGuardo/[email protected]
         with:
           lein: 'latest'
       - run: lein kaocha
       - run: lein kondo
-      - run: lein fmt
+      - run: lein fmt
+      - name: lint javadoc
+        run: ./scripts/javadoc.sh

scripts/javadoc.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# Best practice shell options
+set -euo pipefail
+IFS=$'\n\t'
+
+# Run the javadoc command with the -quiet option
+OUTPUT=`javadoc -quiet -classpath "$(lein classpath)" -Xdoclint:all -d target/javadoc-out $(find src -name "*.java") 2>&1`
+
+# Check if there is any output
+if [ -n "$OUTPUT" ]; then
+  echo "Javadoc warnings or errors detected:"
+  echo "$OUTPUT"
+  exit 1
+else
+  echo "Javadoc completed successfully with no warnings or errors."
+  exit 0
+fi

src/java/io/factorhouse/kpow/key/ClusterIdKeyStrategy.java

@@ -6,7 +6,7 @@
 import java.util.concurrent.ExecutionException;
 
 /**
- * The default key strategy uses the cluster ID, obtained via an {@link org.apache.kafka.clients.admin.Admin#describeClusters()}  call.
+ * The default key strategy uses the cluster ID, obtained via an {@link org.apache.kafka.clients.admin.Admin#describeCluster()}  call.
  * This AdminClient is created once during registry initialization and then closed.
  */
 public class ClusterIdKeyStrategy implements KeyStrategy {