Streamline API details and add more Javadoc

Author: jjohannes

build.gradle.kts

@@ -16,10 +16,6 @@ java {
     sourceCompatibility = JavaVersion.VERSION_1_8
     targetCompatibility = JavaVersion.VERSION_1_8
 }
-tasks.javadoc {
-    (options as CoreJavadocOptions).addStringOption("Xdoclint:none", "-quiet")
-}
-
 val functionalTest: SourceSet by sourceSets.creating
 gradlePlugin.testSourceSets(functionalTest)
 val functionalTestTask = tasks.register<Test>("functionalTest") {

src/main/java/de/jjohannes/gradle/javamodules/AutomaticModuleName.java

@@ -2,7 +2,7 @@
 
 public class AutomaticModuleName extends ModuleSpec {
 
-    public AutomaticModuleName(String identifier, String moduleName) {
+    AutomaticModuleName(String identifier, String moduleName) {
         super(identifier, moduleName);
     }
 }

src/main/java/de/jjohannes/gradle/javamodules/ExtraModuleInfoPlugin.java

@@ -14,6 +14,7 @@
  * Entry point of the plugin.
  */
 @SuppressWarnings("unused")
+@NonNullApi
 public class ExtraModuleInfoPlugin implements Plugin<Project> {
 
     @Override

src/main/java/de/jjohannes/gradle/javamodules/ExtraModuleInfoPluginExtension.java

@@ -18,15 +18,45 @@ public abstract class ExtraModuleInfoPluginExtension {
 
     /**
      * Add full module information for a given Jar file.
+     *
+     * @param identifier group:name coordinates _or_ Jar file name
+     * @param moduleName the Module Name of the Module to construct
+     */
+    public void module(String identifier, String moduleName) {
+        module(identifier, moduleName, null, null);
+    }
+
+    /**
+     * Add full module information for a given Jar file.
+     *
+     * @param identifier group:name coordinates _or_ Jar file name
+     * @param moduleName the Module Name of the Module to construct
+    *  @param moduleVersion version to write into the module-info.class
      */
     public void module(String identifier, String moduleName, String moduleVersion) {
         module(identifier, moduleName, moduleVersion, null);
     }
 
     /**
-     * Add full module information, including exported packages and dependencies, for a given Jar file.
+     * Add full module information for a given Jar file.
+     *
+     * @param identifier group:name coordinates _or_ Jar file name
+     * @param moduleName the Module Name of the Module to construct
+     * @param conf configure exported packages and dependencies, see {@link ModuleInfo}
+     */
+    public void module(String identifier, String moduleName, @Nullable Action<? super ModuleInfo> conf) {
+        module(identifier, moduleName, null, conf);
+    }
+
+    /**
+     * Add full module information for a given Jar file.
+     *
+     * @param identifier group:name coordinates _or_ Jar file name
+     * @param moduleName the Module Name of the Module to construct
+     * @param moduleVersion version to write into the module-info.class
+     * @param conf configure exported packages, dependencies and Jar merging, see {@link ModuleInfo}
      */
-    public void module(String identifier, String moduleName, String moduleVersion, @Nullable Action<? super ModuleInfo> conf) {
+    public void module(String identifier, String moduleName, @Nullable String moduleVersion, @Nullable Action<? super ModuleInfo> conf) {
         ModuleInfo moduleInfo = new ModuleInfo(identifier, moduleName, moduleVersion);
         if (conf != null) {
             conf.execute(moduleInfo);
@@ -35,16 +65,23 @@ public void module(String identifier, String moduleName, String moduleVersion, @
     }
 
     /**
-     * Add only an automatic module name to a given jar file.
+     * Add an Automatic-Module-Name to a given Jar file.
+     *
+     * @param identifier group:name coordinates _or_ Jar file name
+     * @param moduleName the Module Name of the Module to construct
      */
     public void automaticModule(String identifier, String moduleName) {
         automaticModule(identifier, moduleName, null);
     }
 
     /**
-     * Add only an automatic module name to a given jar file.
+     * Add an Automatic-Module-Name to a given Jar file.
+     *
+     * @param identifier group:name coordinates _or_ Jar file name
+     * @param moduleName the Module Name of the Module to construct
+     * @param conf configure Jar merging, see {@link AutomaticModuleName}
      */
-    public void automaticModule(String identifier, String moduleName, @Nullable Action<? super ModuleSpec> conf) {
+    public void automaticModule(String identifier, String moduleName, @Nullable Action<? super AutomaticModuleName> conf) {
         AutomaticModuleName automaticModuleName = new AutomaticModuleName(identifier, moduleName);
         if (conf != null) {
             conf.execute(automaticModuleName);

src/main/java/de/jjohannes/gradle/javamodules/ModuleInfo.java

@@ -8,7 +8,7 @@
  */
 public class ModuleInfo extends ModuleSpec {
 
-    protected final String moduleVersion;
+    private final String moduleVersion;
 
     final Set<String> exports = new LinkedHashSet<>();
     final Set<String> requires = new LinkedHashSet<>();
@@ -21,26 +21,48 @@ public class ModuleInfo extends ModuleSpec {
         this.moduleVersion = moduleVersion;
     }
 
+    /**
+     * @param exports corresponds to the directive in a 'module-info.java' file
+     */
     public void exports(String exports) {
         addOrThrow(this.exports, exports);
     }
 
+    /**
+     * @param requires corresponds to the directive in a 'module-info.java' file
+     */
     public void requires(String requires) {
         addOrThrow(this.requires, requires);
     }
 
+    /**
+     * @param requiresTransitive corresponds to the directive in a 'module-info.java' file
+     */
     public void requiresTransitive(String requiresTransitive) {
         addOrThrow(this.requiresTransitive, requiresTransitive);
     }
 
+    /**
+     * @param requiresStatic corresponds to the directive in a 'module-info.java' file
+     */
     public void requiresStatic(String requiresStatic) {
         addOrThrow(this.requiresStatic, requiresStatic);
     }
 
+    /**
+     * @param ignoreServiceProvider do not transfer service provider to the 'module-info.class'
+     */
     public void ignoreServiceProvider(String ignoreServiceProvider) {
         addOrThrow(this.ignoreServiceProviders, ignoreServiceProvider);
     }
 
+    /**
+     * @return configured version of the Module
+     */
+    public String getModuleVersion() {
+        return moduleVersion;
+    }
+
     private static void addOrThrow(Set<String> target, String element) {
         if (!target.add(element)) {
             throw new IllegalArgumentException("The element '" + element + "' is already specified");

src/main/java/de/jjohannes/gradle/javamodules/ModuleSpec.java

@@ -4,29 +4,44 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Details that real Modules and Automatic-Module-Names share.
+ */
 abstract public class ModuleSpec implements Serializable {
 
     private final String identifier;
     private final String moduleName;
     private final List<String> mergedJars = new ArrayList<>();
 
-    public ModuleSpec(String identifier, String moduleName) {
+    ModuleSpec(String identifier, String moduleName) {
         this.identifier = identifier;
         this.moduleName = moduleName;
     }
 
+    /**
+     * @return group:name coordinates _or_ Jar file name
+     */
     public String getIdentifier() {
         return identifier;
     }
 
+    /**
+     * @return Module Name of the Module to construct
+     */
     public String getModuleName() {
         return moduleName;
     }
 
+    /**
+     * @param identifier group:name coordinates _or_ Jar file name (of the Jar file to merge)
+     */
     public void mergeJar(String identifier) {
         mergedJars.add(identifier);
     }
 
+    /**
+     * @return all merged Jar identifiers
+     */
     public List<String> getMergedJars() {
         return mergedJars;
     }