Fix test - add javadoc comments to avoid warnings

big-andy-coates · big-andy-coates · commit afe416f9e139 · 2024-02-18T12:31:33.000Z
diff --git a/src/test/java/org/javamodularity/moduleplugin/ModulePluginSmokeTest.java b/src/test/java/org/javamodularity/moduleplugin/ModulePluginSmokeTest.java
@@ -263,7 +263,7 @@ void smokeTestRunStartScripts(
 
     @Test
     void shouldNotCheckInWithCommentedOutVersions() {
-        assertEquals(10, GradleVersion.values().length);
+        assertEquals(8, GradleVersion.values().length);
     }
 
     private static void assertTasksSuccessful(BuildResult result, String subprojectName, String... taskNames) {
diff --git a/test-project-mixed/greeter.api-jdk8/src/main/java/examples/greeter/api/Greeter.java b/test-project-mixed/greeter.api-jdk8/src/main/java/examples/greeter/api/Greeter.java
@@ -1,5 +1,12 @@
 package examples.greeter.api;
 
+/**
+ * Test docs
+ */
 public interface Greeter {
+    /**
+     * Test docs
+     * @return test docs
+     */
     String hello();
 }
diff --git a/test-project-mixed/greeter.api-jdk8/src/main/java/module-info.java b/test-project-mixed/greeter.api-jdk8/src/main/java/module-info.java
@@ -1,3 +1,6 @@
+/**
+ * Test docs
+ */
 module greeter.api {
     exports examples.greeter.api;
 }
diff --git a/test-project-mixed/greeter.provider-jdk11.test-jdk11/src/main/java/module-info.java b/test-project-mixed/greeter.provider-jdk11.test-jdk11/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider.test {
     requires greeter.api;
 
diff --git a/test-project-mixed/greeter.provider-jdk11.test-jdk11/src/main/java/tests/GreeterLocator.java b/test-project-mixed/greeter.provider-jdk11.test-jdk11/src/main/java/tests/GreeterLocator.java
@@ -4,7 +4,14 @@
 
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class GreeterLocator {
+    /**
+     * Test docs
+     * @return test docs
+     */
     public Greeter findGreeter() {
         return ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found"));
     }
diff --git a/test-project-mixed/greeter.provider-jdk11/src/main/java/examples/greeter/Friendly.java b/test-project-mixed/greeter.provider-jdk11/src/main/java/examples/greeter/Friendly.java
@@ -5,7 +5,13 @@
 import java.util.*;
 import javax.annotation.Nonnull;
 
+/**
+ * Test docs
+ */
 public class Friendly implements Greeter {
+    /**
+     * Test docs
+     */
     @Override @Nonnull
     public String hello() {
         var stream = this.getClass().getResourceAsStream("/greeting.txt");
diff --git a/test-project-mixed/greeter.provider-jdk11/src/main/java/module-info.java b/test-project-mixed/greeter.provider-jdk11/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider {
     requires greeter.api;
     requires java.annotation;
diff --git a/test-project-mixed/greeter.provider-jdk8.test-jdk11/src/main/java/module-info.java b/test-project-mixed/greeter.provider-jdk8.test-jdk11/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider.test {
     requires greeter.api;
 
diff --git a/test-project-mixed/greeter.provider-jdk8.test-jdk11/src/main/java/tests/GreeterLocator.java b/test-project-mixed/greeter.provider-jdk8.test-jdk11/src/main/java/tests/GreeterLocator.java
@@ -4,7 +4,14 @@
 
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class GreeterLocator {
+    /**
+     * Test docs
+     * @return test docs
+     */
     public Greeter findGreeter() {
         return ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found"));
     }
diff --git a/test-project-mixed/greeter.provider-jdk8.test-jdk8/src/main/java/module-info.java b/test-project-mixed/greeter.provider-jdk8.test-jdk8/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider.test {
     requires greeter.api;
 
diff --git a/test-project-mixed/greeter.provider-jdk8.test-jdk8/src/main/java/tests/GreeterLocator.java b/test-project-mixed/greeter.provider-jdk8.test-jdk8/src/main/java/tests/GreeterLocator.java
@@ -4,7 +4,14 @@
 
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class GreeterLocator {
+    /**
+     * Test docs
+     * @return test docs
+     */
     public Greeter findGreeter() {
         return ServiceLoader.load(Greeter.class).iterator().next(); // no ServiceLoader.findFirst() in JDK 8
     }
diff --git a/test-project-mixed/greeter.provider-jdk8/src/main/java/examples/greeter/Friendly.java b/test-project-mixed/greeter.provider-jdk8/src/main/java/examples/greeter/Friendly.java
@@ -5,7 +5,13 @@
 import java.util.*;
 import javax.annotation.Nonnull;
 
+/**
+ * Test docs
+ */
 public class Friendly implements Greeter {
+    /**
+     * Test docs
+     */
     @Override @Nonnull
     public String hello() {
         InputStream stream = this.getClass().getResourceAsStream("/greeting.txt");
diff --git a/test-project-mixed/greeter.provider-jdk8/src/main/java/module-info.java b/test-project-mixed/greeter.provider-jdk8/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider {
     requires greeter.api;
     requires java.annotation;
diff --git a/test-project/greeter.api/src/main/java/examples/greeter/api/Greeter.java b/test-project/greeter.api/src/main/java/examples/greeter/api/Greeter.java
@@ -1,5 +1,12 @@
 package examples.greeter.api;
 
+/**
+ * Test docs
+ */
 public interface Greeter {
+    /**
+     * Test docs
+     * @return test docs
+     */
     String hello();
 }
diff --git a/test-project/greeter.api/src/main/java/module-info.java b/test-project/greeter.api/src/main/java/module-info.java
@@ -1,3 +1,6 @@
+/**
+ * Test docs
+ */
 module greeter.api {
     exports examples.greeter.api;
 }
diff --git a/test-project/greeter.javaexec/src/main/java/demo/Demo1.java b/test-project/greeter.javaexec/src/main/java/demo/Demo1.java
@@ -3,7 +3,14 @@
 import examples.greeter.api.Greeter;
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class Demo1 {
+    /**
+     * Test docs
+     * @param args test docs
+     */
     public static void main(String[] args) {
         Greeter greeter = ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found!"));
         System.out.println("Demo1: " + greeter.hello());
diff --git a/test-project/greeter.javaexec/src/main/java/demo/Demo2.java b/test-project/greeter.javaexec/src/main/java/demo/Demo2.java
@@ -3,7 +3,14 @@
 import examples.greeter.api.Greeter;
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class Demo2 {
+    /**
+     * Test docs
+     * @param args test docs
+     */
     public static void main(String[] args) {
         Greeter greeter = ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found!"));
         System.out.println("Demo2: " + greeter.hello());
diff --git a/test-project/greeter.javaexec/src/main/java/module-info.java b/test-project/greeter.javaexec/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.javaexec {
     requires greeter.api;
 
diff --git a/test-project/greeter.provider.test/src/main/java/module-info.java b/test-project/greeter.provider.test/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider.test {
     requires greeter.api;
 
diff --git a/test-project/greeter.provider.test/src/main/java/tests/GreeterLocator.java b/test-project/greeter.provider.test/src/main/java/tests/GreeterLocator.java
@@ -4,7 +4,14 @@
 
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class GreeterLocator {
+    /**
+     * Test docs
+     * @return test docs
+     */
     public Greeter findGreeter() {
         return ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found"));
     }
diff --git a/test-project/greeter.provider.testfixture/src/main/java/module-info.java b/test-project/greeter.provider.testfixture/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider.testfixture {
     requires greeter.api;
 
diff --git a/test-project/greeter.provider.testfixture/src/main/java/testfixture/GreeterLocator.java b/test-project/greeter.provider.testfixture/src/main/java/testfixture/GreeterLocator.java
@@ -4,7 +4,14 @@
 
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class GreeterLocator {
+    /**
+     * Test docs
+     * @return test docs
+     */
     public Greeter findGreeter() {
         return ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found"));
     }
diff --git a/test-project/greeter.provider/src/main/java/examples/greeter/Friendly.java b/test-project/greeter.provider/src/main/java/examples/greeter/Friendly.java
@@ -5,7 +5,13 @@
 import java.util.*;
 import javax.annotation.Nonnull;
 
+/**
+ * Test docs
+ */
 public class Friendly implements Greeter {
+    /**
+     * Test docs
+     */
     @Override @Nonnull
     public String hello() {
         var stream = this.getClass().getResourceAsStream("/greeting.txt");
diff --git a/test-project/greeter.provider/src/main/java/module-info.java b/test-project/greeter.provider/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.provider {
     requires greeter.api;
     requires java.annotation;
diff --git a/test-project/greeter.runner/src/main/java/examples/Runner.java b/test-project/greeter.runner/src/main/java/examples/Runner.java
@@ -5,7 +5,14 @@
 import java.util.Arrays;
 import java.util.ServiceLoader;
 
+/**
+ * Test docs
+ */
 public class Runner {
+    /**
+     * Test docs
+     * @param args test docs
+     */
     public static void main(String[] args) {
         System.out.println("args: " + Arrays.asList(args));
         System.out.println("greeter.sender: " + System.getProperty("greeter.sender"));
diff --git a/test-project/greeter.runner/src/main/java/module-info.java b/test-project/greeter.runner/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.runner {
     requires greeter.api;
 
diff --git a/test-project/greeter.startscripts/src/main/java/module-info.java b/test-project/greeter.startscripts/src/main/java/module-info.java
@@ -1,5 +1,8 @@
 import examples.greeter.api.Greeter;
 
+/**
+ * Test docs
+ */
 module greeter.startscripts {
     requires greeter.api;
 
diff --git a/test-project/greeter.startscripts/src/main/java/startscripts/Demo1.java b/test-project/greeter.startscripts/src/main/java/startscripts/Demo1.java
@@ -1,6 +1,13 @@
 package startscripts;
 
+/**
+ * Test docs
+ */
 public class Demo1 {
+    /**
+     * Test docs
+     * @param args test docs
+     */
     public static void main(String[] args) {
         DemoHelper.greet("Demo1", args);
     }
diff --git a/test-project/greeter.startscripts/src/main/java/startscripts/Demo2.java b/test-project/greeter.startscripts/src/main/java/startscripts/Demo2.java
@@ -1,6 +1,13 @@
 package startscripts;
 
+/**
+ * Test docs
+ */
 public class Demo2 {
+    /**
+     * Test docs
+     * @param args test docs
+     */
     public static void main(String[] args) {
         DemoHelper.greet("Demo2", args);
     }
diff --git a/test-project/greeter.startscripts/src/main/java/startscripts/DemoHelper.java b/test-project/greeter.startscripts/src/main/java/startscripts/DemoHelper.java
@@ -5,7 +5,15 @@
 import java.util.ServiceLoader;
 import java.util.stream.Collectors;
 
+/**
+ * Test docs
+ */
 public class DemoHelper {
+    /**
+     * Test docs
+     * @param appName test docs
+     * @param args test docs
+     */
     public static void greet(String appName, String[] args) {
         Greeter greeter = ServiceLoader.load(Greeter.class).findFirst().orElseThrow(() -> new RuntimeException("No Greeter found!"));
         String addition = System.getProperty("greeting.addition", "");
diff --git a/test-project/greeter.startscripts/src/main/java/startscripts/MainDemo.java b/test-project/greeter.startscripts/src/main/java/startscripts/MainDemo.java
@@ -1,6 +1,13 @@
 package startscripts;
 
+/**
+ * Test docs
+ */
 public class MainDemo {
+    /**
+     * Test docs
+     * @param args test docs
+     */
     public static void main(String[] args) {
         DemoHelper.greet("MainDemo", args);
     }

Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ void smokeTestRunStartScripts(`
`263`	`263`
`264`	`264`	`@Test`
`265`	`265`	`void shouldNotCheckInWithCommentedOutVersions() {`
`266`		`- assertEquals(10, GradleVersion.values().length);`
	`266`	`+ assertEquals(8, GradleVersion.values().length);`
`267`	`267`	`}`
`268`	`268`
`269`	`269`	`private static void assertTasksSuccessful(BuildResult result, String subprojectName, String... taskNames) {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,6 @@`
	`1`	`+/**`
	`2`	`+ * Test docs`
	`3`	`+ */`
`1`	`4`	`module greeter.api {`
`2`	`5`	`exports examples.greeter.api;`
`3`	`6`	`}`