Add Javadoc

Fixes #12

Author: jjohannes

src/main/java/de/jjohannes/gradle/moduledependencies/JavaModuleDependenciesExtension.java

@@ -14,15 +14,30 @@
 
 import static java.util.Optional.empty;
 
+/**
+ * - Configure behavior of the 'java-module-dependencies' plugin
+ * - Add additional mappings using {@link #getModuleNameToGA()}
+ * - Define dependencies and dependency constraints by Module Name
+ *   using {@link #ga(String)}, {@link #gav(String, String)} or {@link #gav(String)}
+ */
 public abstract class JavaModuleDependenciesExtension {
     static final String JAVA_MODULE_DEPENDENCIES = "javaModuleDependencies";
 
     private final VersionCatalogsExtension versionCatalogs;
 
+    /**
+     * @return the mappings from Module Name to GA coordinates; can be modified
+     */
     public abstract MapProperty<String, String> getModuleNameToGA();
 
+    /**
+     * @return If a Version Catalog is used: print a WARN for missing versions (default is 'true')
+     */
     public abstract Property<Boolean> getWarnForMissingVersions();
 
+    /**
+     * @return If a Version Catalog is used: which catalog? (default is 'libs')
+     */
     public abstract Property<String> getVersionCatalogName();
 
     public JavaModuleDependenciesExtension(VersionCatalogsExtension versionCatalogs) {
@@ -35,6 +50,9 @@ public JavaModuleDependenciesExtension(VersionCatalogsExtension versionCatalogs)
     /**
      * Converts 'Module Name' to GA coordinates that can be used in
      * dependency declarations as String: "group:name"
+     *
+     * @param moduleName The Module Name
+     * @return Dependency notation
      */
     public Provider<String> ga(String moduleName) {
         return getModuleNameToGA().getting(moduleName);
@@ -43,15 +61,23 @@ public Provider<String> ga(String moduleName) {
     /**
      * Converts 'Module Name' and 'Version' to GA coordinates that can be used in
      * dependency declarations as String: "group:name:version"
+     *
+     * @param moduleName The Module Name
+     * @param version The (required) version
+     * @return Dependency notation
      */
     public Provider<String> gav(String moduleName, String version) {
         return getModuleNameToGA().getting(moduleName).map(s -> s + ":" + version);
     }
 
     /**
+     * If a Version Catalog is used:
      * Converts 'Module Name' and the matching 'Version' from the Version Catalog to
      * GAV coordinates that can be used in dependency Declarations as Map:
      * [group: "...", name: "...", version: "..."]
+     *
+     * @param moduleName The Module Name
+     * @return Dependency notation
      */
     public Provider<Map<String, Object>> gav(String moduleName) {
         Provider<String> ga = ga(moduleName);
@@ -73,6 +99,12 @@ public Provider<Map<String, Object>> gav(String moduleName) {
         });
     }
 
+    /**
+     * Finds the Module Name for given coordinates
+     *
+     * @param ga The GA coordinates
+     * @return the first name found or 'null'
+     */
     @Nullable
     public String moduleName(String ga) {
         for(Map.Entry<String, String> mapping: getModuleNameToGA().get().entrySet()) {