Add Javadoc

Author: jjohannes

src/main/java/de/jjohannes/gradle/moduletesting/JavaModuleTestingExtension.java

@@ -36,17 +36,41 @@ public JavaModuleTestingExtension(Project project, JavaModuleDetector moduleDete
         this.moduleDetector = moduleDetector;
     }
 
+    /**
+     * Turn the given JVM Test Suite into a Blackbox Test Suite.
+     * For example:
+     *
+     * javaModuleTesting.blackbox(testing.suites["integtest"])
+     */
     public void blackbox(TestSuite jvmTestSuite) {
         if (jvmTestSuite instanceof JvmTestSuite) {
             configureJvmTestSuiteForBlackbox((JvmTestSuite) jvmTestSuite);
         }
     }
 
+    /**
+     * Turn the given JVM Test Suite into a Whitebox Test Suite.
+     * For example:
+     *
+     * javaModuleTesting.whitebox(testing.suites["test"])
+     */
     public void whitebox(TestSuite jvmTestSuite) {
         whitebox(jvmTestSuite, NO_OP_ACTION);
 
     }
 
+    /**
+     * Turn the given JVM Test Suite into a Whitebox Test Suite.
+     * If needed, configure additional 'requires' and open the
+     * test packages for reflection.
+     *
+     * For example, for JUnit 5, you need at least:
+     *
+     * javaModuleTesting.whitebox(testing.suites["test"]) {
+     *   requires.add("org.junit.jupiter.api")
+     *   opensTo.add("org.junit.platform.commons")
+     * }
+     */
     public void whitebox(TestSuite jvmTestSuite, Action<WhiteboxJvmTestSuite> conf) {
         if (jvmTestSuite instanceof JvmTestSuite) {
             WhiteboxJvmTestSuite whiteboxJvmTestSuite = project.getObjects().newInstance(WhiteboxJvmTestSuite.class);

src/main/java/de/jjohannes/gradle/moduletesting/JavaModuleTestingPlugin.java

@@ -5,7 +5,7 @@
 import org.gradle.api.Project;
 import org.gradle.util.GradleVersion;
 
-@SuppressWarnings({"unused"})
+@SuppressWarnings("unused")
 @NonNullApi
 public abstract class JavaModuleTestingPlugin implements Plugin<Project> {
 

src/main/java/de/jjohannes/gradle/moduletesting/WhiteboxJvmTestSuite.java

@@ -6,9 +6,22 @@
 
 public interface WhiteboxJvmTestSuite {
 
+    /**
+     * Configure which source set contains the 'sources under test' for
+     * this Whitebox Test Suite - defaults to 'main'.
+     */
     Property<SourceSet> getSourcesUnderTest();
 
+    /**
+     * Add additional 'requires' directives for the test code.
+     * For example, 'requires.add("org.junit.jupiter.api")'.
+     */
     ListProperty<String> getRequires();
 
+    /**
+     * Open all packages of this Whitebox Test Suite to a given Module
+     * for reflection at runtime.
+     * For example, 'opensTo.add("org.junit.platform.commons")'.
+     */
     ListProperty<String> getOpensTo();
 }