Fix javadoc (#586)

iocanel · web-flow · commit e95d5068e321 · 2026-04-07T12:20:55.000+03:00
* fix(javadoc): incosistencies

* fix: javadoc config options
diff --git a/adapters/source/src/main/java/io/sundr/adapter/source/utils/Sources.java b/adapters/source/src/main/java/io/sundr/adapter/source/utils/Sources.java
@@ -44,6 +44,7 @@ public class Sources {
    * Read the first {@link TypeDef} instance from an {@link InputStream}.
    *
    * @param path the {@link Path}
+   * @param ctx the {@link AdapterContext}
    * @return the first {@link TypeDef} instance, or throw an exception if none is found.
    */
   public static TypeDef readTypeDefFromPath(Path path, AdapterContext ctx) {
@@ -58,6 +59,7 @@ public static TypeDef readTypeDefFromPath(Path path, AdapterContext ctx) {
    * Read the first {@link TypeDef} instance from an {@link InputStream}.
    *
    * @param is the {@link InputStream}
+   * @param ctx the {@link AdapterContext}
    * @return the first {@link TypeDef} instance, or throw an exception if none is found.
    */
   public static TypeDef readTypeDefFromStream(InputStream is, AdapterContext ctx) {
@@ -68,6 +70,7 @@ public static TypeDef readTypeDefFromStream(InputStream is, AdapterContext ctx)
    * Read a {@link List} of {@link TypeDef} instances from an {@link InputStream}.
    *
    * @param is the {@link InputStream}
+   * @param ctx the {@link AdapterContext}
    * @return a {@link List} of {@link TypeDef} instances.
    */
   public static List<TypeDef> readTypeDefsFromStream(InputStream is, AdapterContext ctx) {
@@ -99,7 +102,7 @@ public static TypeDeclaration<?> readTypeFromStream(InputStream is) {
   /**
    * Read a {@link List} of {@link TypeDeclaration} instances from a classpath resource.
    *
-   * @param resourceName the {@link InputStream}
+   * @param resourceName the classpath resource name
    * @return a {@link List} of {@link TypeDeclaration} instances.
    */
   public static List<TypeDeclaration<?>> readTypesFromResource(String resourceName) {
@@ -110,7 +113,7 @@ public static List<TypeDeclaration<?>> readTypesFromResource(String resourceName
   /**
    * Read a {@link TypeDeclaration} instance from a classpath resource.
    *
-   * @param resourceName the {@link InputStream}
+   * @param resourceName the classpath resource name
    * @return the {@link TypeDeclaration} instance.
    */
   public static TypeDeclaration<?> readTypeFromResource(String resourceName) {
@@ -120,7 +123,7 @@ public static TypeDeclaration<?> readTypeFromResource(String resourceName) {
   /**
    * Read the first {@link TypeDef} instance from a classpath resource.
    *
-   * @param resourceName the {@link InputStream}
+   * @param resourceName the classpath resource name
    * @param ctx the {@link AdapterContext}
    * @return the first {@link TypeDef} instance, or throw an exception if none is found.
    */
@@ -132,7 +135,8 @@ public static TypeDef readTypeDefFromResource(String resourceName, AdapterContex
   /**
    * Read a {@link List} of {@link TypeDef} instances from a classpath resource.
    *
-   * @param resourceName the {@link InputStream}
+   * @param resourceName the resource name
+   * @param ctx the {@link AdapterContext}
    * @return a {@link List} of {@link TypeDef} instances.
    */
   public static List<TypeDef> readTypeDefsFromResource(String resourceName, AdapterContext ctx) {
diff --git a/annotations/builder/src/main/java/io/sundr/builder/internal/functions/Construct.java b/annotations/builder/src/main/java/io/sundr/builder/internal/functions/Construct.java
@@ -87,7 +87,7 @@ private String usingConstructor(List<String> item) {
   /**
    * Checks that a constructor with the required number of arguments is found.
    *
-   * @param arguments
+   * @param arguments The expected number of constructor arguments.
    */
   private void checkConstructorArguments(int arguments) {
     if (arguments == 0 && (typeDef.getConstructors() == null || typeDef.getConstructors().isEmpty())) {
@@ -108,7 +108,7 @@ private void checkConstructorArguments(int arguments) {
   /**
    * Checks that a factory method with the required number of arguments is found.
    *
-   * @param arguments
+   * @param arguments The expected number of factory method arguments.
    */
   private void checkFactoryMethodArguments(int arguments) {
     for (Method m : typeDef.getMethods()) {
diff --git a/annotations/builder/src/main/java/io/sundr/builder/internal/functions/ToConstructExpression.java b/annotations/builder/src/main/java/io/sundr/builder/internal/functions/ToConstructExpression.java
@@ -88,7 +88,7 @@ private Expression usingConstructor(List<Expression> item) {
   /**
    * Checks that a constructor with the required number of arguments is found.
    *
-   * @param arguments
+   * @param arguments The expected number of constructor arguments.
    */
   private void checkConstructorArguments(int arguments) {
     if (arguments == 0 && (typeDef.getConstructors() == null || typeDef.getConstructors().isEmpty())) {
@@ -109,7 +109,7 @@ private void checkConstructorArguments(int arguments) {
   /**
    * Checks that a factory method with the required number of arguments is found.
    *
-   * @param arguments
+   * @param arguments The expected number of factory method arguments.
    */
   private void checkFactoryMethodArguments(int arguments) {
     for (Method m : typeDef.getMethods()) {
diff --git a/annotations/builder/src/main/java/io/sundr/builder/internal/functions/ToPojo.java b/annotations/builder/src/main/java/io/sundr/builder/internal/functions/ToPojo.java
@@ -774,7 +774,7 @@ private static String relativePackage(String pkg, String relativePath) {
    * @param source The source type of the reference..
    * @param target The target type.
    * @param targetBuilder The target type builder.
-   * @return
+   * @return The string representation of the converted reference.
    */
   private static String convertReference(String ref, TypeDef source, TypeDef target, TypeDef targetBuilder) {
     StringBuilder sb = new StringBuilder();
@@ -788,7 +788,7 @@ private static String convertReference(String ref, TypeDef source, TypeDef targe
    * @param ref The ref.
    * @param source The source type of the reference..
    * @param target The target type.
-   * @return
+   * @return The string representation of the converted reference.
    */
   private static String convertReference(String ref, TypeDef source, TypeDef target) {
     Method ctor = BuilderUtils.findBuildableConstructor(target);
@@ -1047,7 +1047,7 @@ private static String readAnnotationField(String ref, TypeDef source, Field fiel
    * @param source The source type of the reference (e.g. the annotation).
    * @param target The target type (e.g. the generated pojo).
    * @param targetBuilder The target type builder (e.g. the pojo builder.
-   * @return
+   * @return The string representation of the converted map.
    */
   private static String convertMap(String ref, TypeDef source, TypeDef target, TypeDef targetBuilder) {
     StringBuilder sb = new StringBuilder();
@@ -1065,7 +1065,7 @@ private static Expression convertMapExpression(Expression expression, TypeDef ta
    * @param ref The ref.
    * @param source The source type of the reference (e.g. the annotation).
    * @param target The target type (e.g. the generated pojo).
-   * @return
+   * @return The string representation of the converted map.
    */
   private static String convertMap(String ref, TypeDef source, TypeDef target) {
     Method ctor = BuilderUtils.findBuildableConstructor(target);
@@ -1090,7 +1090,7 @@ private static Expression convertMapExpression(Expression expression, TypeDef ta
    *
    * @param ref The reference.
    * @param source The type of the reference.
-   * @param field The field to read.
+   * @param argument The argument to read.
    * @return The code.
    */
   private static String readMapValue(String ref, TypeDef source, Argument argument) {
diff --git a/annotations/builder/src/main/java/io/sundr/builder/internal/utils/BuilderUtils.java b/annotations/builder/src/main/java/io/sundr/builder/internal/utils/BuilderUtils.java
@@ -272,7 +272,7 @@ private static boolean hasBuildableAnnotation(Method method) {
    * Checks if method has a specific argument.
    *
    * @param method The method.
-   * @param property The argument.
+   * @param variable The argument.
    * @return True if matching argument if found.
    */
   public static boolean methodHasArgument(Method method, Variable<?> variable) {
@@ -590,7 +590,7 @@ public static String qualifyPropertyName(Field field, TypeRef typeRef, TypeDef o
    * @param field The property.
    * @param typeRef The type reference.
    * @param originType The origin type.
-   *        param useSingular Flag to use singular form
+   * @param useSingular Flag to use singular form.
    * @return The qualified property name.
    */
   public static String qualifyPropertyName(Field field, TypeRef typeRef, TypeDef originType, boolean useSingular) {
diff --git a/annotations/transform/src/main/java/io/sundr/transform/annotations/AnnotationSelector.java b/annotations/transform/src/main/java/io/sundr/transform/annotations/AnnotationSelector.java
@@ -29,14 +29,14 @@
   /**
    * The annotation class to use for selecting classes.
    *
-   * @return
+   * @return The annotation class.
    */
   Class<? extends Annotation> value();
 
   /**
    * The package selector to use to filter selected annotated classes.
    *
-   * @return
+   * @return The package selectors.
    */
   PackageSelector[] packages() default {};
 }
diff --git a/annotations/transform/src/main/java/io/sundr/transform/annotations/PackageSelector.java b/annotations/transform/src/main/java/io/sundr/transform/annotations/PackageSelector.java
@@ -28,13 +28,14 @@
   /**
    * The package to use for selecting classes.
    *
-   * @return
+   * @return The package name.
    */
   String value();
 
   /**
+   * The pattern used to filter class names within the package.
    *
-   * @return
+   * @return The class name pattern.
    */
   String pattern() default "[a-zA-Z_$][a-zA-Z0-9_$]*";
 }
diff --git a/annotations/transform/src/main/java/io/sundr/transform/annotations/ResourceSelector.java b/annotations/transform/src/main/java/io/sundr/transform/annotations/ResourceSelector.java
@@ -26,9 +26,9 @@
 public @interface ResourceSelector {
 
   /**
-   * The package to use for selecting classes.
+   * The resource name to use for selecting classes.
    *
-   * @return
+   * @return The resource name.
    */
   String value();
 }
diff --git a/core/src/main/java/io/sundr/functions/Pluralize.java b/core/src/main/java/io/sundr/functions/Pluralize.java
@@ -88,7 +88,7 @@ public String apply(String word) {
    * Rudimentary implementation of checking whether word is plural or not.
    * It can be further improved to handle complex cases.
    *
-   * @param word
+   * @param word The word to check.
    * @return Boolean value indicating whether it's already plural or not
    */
   private boolean isAlreadyPlural(String word) {
diff --git a/maven-plugin/src/main/java/io/sundr/maven/GenerateBomMojo.java b/maven-plugin/src/main/java/io/sundr/maven/GenerateBomMojo.java
@@ -405,7 +405,7 @@ private void build(MavenSession session, MavenProject project, List<MavenProject
   /**
    * Returns all the session/reactor artifacts topologically sorted.
    *
-   * @return
+   * @return The sorted set of session artifacts.
    */
   private Set<Artifact> getSessionArtifacts() {
     Set<Artifact> result = new LinkedHashSet<Artifact>();
@@ -418,7 +418,7 @@ private Set<Artifact> getSessionArtifacts() {
   /**
    * Returns all dependency artifacts in all modules, excluding all reactor artifacts (including attached).
    *
-   * @return
+   * @return The set of project dependency artifacts.
    */
   private Set<Artifact> getProjectDependencies() {
     Set<Artifact> result = new LinkedHashSet<Artifact>();
@@ -433,7 +433,7 @@ private Set<Artifact> getProjectDependencies() {
   /**
    * Returns all dependencies defined in dependency management of the root pom.
    *
-   * @return
+   * @return The set of dependency management artifacts.
    */
   private Set<Artifact> getProjectDependencyManagement() {
     Set<Artifact> result = new LinkedHashSet<Artifact>();
@@ -447,9 +447,9 @@ private Set<Artifact> getProjectDependencyManagement() {
   }
 
   /**
-   * Returns all dependencies defined in dependency management of the root pom.
+   * Returns all plugin management entries defined in the root pom.
    *
-   * @return
+   * @return The set of plugin management artifacts.
    */
   private Set<Artifact> getProjectPluginManagement() {
     Set<Artifact> result = new LinkedHashSet<Artifact>();
@@ -466,8 +466,8 @@ private Set<Artifact> getProjectPluginManagement() {
    * Collects dependencies, including transitives.
    * Project dependencies retain their scope, while test only dependencies (including transitives) will have test scope.
    *
-   * @param projectDependencies
-   * @return
+   * @param projectDependencies The direct project dependencies to resolve transitives from.
+   * @return The full set of artifacts including transitives.
    */
   private Set<Artifact> getDependencies(final Set<Artifact> projectDependencies) {
     Set<Artifact> result = new LinkedHashSet<Artifact>(projectDependencies);
diff --git a/model/utils/src/main/java/io/sundr/model/utils/Collections.java b/model/utils/src/main/java/io/sundr/model/utils/Collections.java
@@ -183,6 +183,9 @@ public Boolean apply(TypeRef type) {
   /**
    * If the supplied type implements {@link java.util.Collection} (directly or indirectly), determine its generic element type.
    * Otherwise, return {@link Optional#empty()}
+   *
+   * @param type The type to inspect.
+   * @return The element type if present, or empty.
    */
   public static Optional<TypeRef> getCollectionElementType(TypeRef type) {
     return extractArgument(type, AS_COLLECTION, 0);
@@ -191,6 +194,9 @@ public static Optional<TypeRef> getCollectionElementType(TypeRef type) {
   /**
    * If the supplied type implements {@link java.util.Map} (directly or indirectly), determine its generic key type. Otherwise,
    * return {@link Optional#empty()}
+   *
+   * @param mapType The map type to inspect.
+   * @return The key type if present, or empty.
    */
   public static Optional<TypeRef> getMapKeyType(TypeRef mapType) {
     return extractArgument(mapType, AS_MAP, 0);
@@ -199,6 +205,9 @@ public static Optional<TypeRef> getMapKeyType(TypeRef mapType) {
   /**
    * If the supplied type implements {@link java.util.Map} (directly or indirectly), determine its generic value type.
    * Otherwise, return {@link Optional#empty()}
+   *
+   * @param mapType The map type to inspect.
+   * @return The value type if present, or empty.
    */
   public static Optional<TypeRef> getMapValueType(TypeRef mapType) {
     return extractArgument(mapType, AS_MAP, 1);
diff --git a/model/utils/src/main/java/io/sundr/model/utils/Getter.java b/model/utils/src/main/java/io/sundr/model/utils/Getter.java
@@ -116,7 +116,7 @@ public static boolean is(Method method) {
    *
    * @param method The method.
    * @param acceptPrefixless Flag to enable support of prefixless getters.
-   * @return
+   * @return True if the method is a getter, false otherwise.
    */
   public static boolean is(Method method, boolean acceptPrefixless) {
     int length = method.getName().length();
diff --git a/model/utils/src/main/java/io/sundr/model/utils/TypeArguments.java b/model/utils/src/main/java/io/sundr/model/utils/TypeArguments.java
@@ -107,6 +107,7 @@ public static RichTypeDef apply(TypeDef definition) {
    * However, if the reference does contain generic arguments, their count must be equal to the definition.
    *
    * @param ref The class reference to evaluate. The corresponding definition will be loaded using {@link GetDefinition}
+   * @return A map from type parameter names to their concrete type arguments.
    */
   public static Map<String, TypeRef> getGenericArgumentsMappings(ClassRef ref) {
     return getGenericArgumentsMappings(ref, GetDefinition.of(ref));
@@ -124,7 +125,8 @@ public static Map<String, TypeRef> getGenericArgumentsMappings(ClassRef ref) {
    * However, if the reference does contain generic arguments, their count must be equal to the definition.
    *
    * @param ref The class reference to evaluate.
-   * @param definition The corresponding definition
+   * @param definition The corresponding definition.
+   * @return A map from type parameter names to their concrete type arguments.
    */
   public static Map<String, TypeRef> getGenericArgumentsMappings(ClassRef ref, TypeDef definition) {
     List<TypeRef> arguments = ref.getArguments();
diff --git a/model/utils/src/main/java/io/sundr/model/utils/Types.java b/model/utils/src/main/java/io/sundr/model/utils/Types.java
@@ -168,7 +168,7 @@ public static TypeRef box(TypeRef ref) {
    *
    * @param type The type to compare.
    * @param targetType The target type.
-   * @param function
+   * @param function The recursive function used to check implements/extends hierarchy.
    * @return true if match, false otherwise.
    */
   public static boolean isInstanceOf(TypeRef type, TypeDef targetType, Function<TypeRef, Boolean> function) {
@@ -413,7 +413,7 @@ public static boolean isBoolean(TypeRef type) {
    * Checks if a {@link TypeRef} is an array.
    *
    * @param type The type to check.
-   * @return True if its an array.B
+   * @return True if its an array.
    */
   public static boolean isArray(TypeRef type) {
 
@@ -487,6 +487,7 @@ public static boolean isOptionalLong(TypeRef type) {
   /**
    * Check if type is an internal JDK type.
    *
+   * @param type The type to check.
    * @return true if jdk type, false otherwise.
    */
   public static boolean isJdkType(TypeRef type) {
@@ -528,7 +529,7 @@ public static boolean hasMethod(TypeDef typeDef, String method) {
    * Checks if property exists on the specified type.
    *
    * @param typeDef The type.
-   * @param property The property name.
+   * @param name The field name.
    * @return True if method is found, false otherwise.
    */
   public static boolean hasField(TypeDef typeDef, String name) {
diff --git a/pom.xml b/pom.xml
@@ -393,7 +393,9 @@
                       <goal>jar</goal>
                     </goals>
                     <configuration>
-                      <additionalparam>${javadoc.opts}</additionalparam>
+                      <additionalJOptions>
+                        <additionalJOption>${javadoc.opts}</additionalJOption>
+                      </additionalJOptions>
                     </configuration>
                   </execution>
                 </executions>

Original file line number	Diff line number	Diff line change
`@@ -29,14 +29,14 @@`
`29`	`29`	`/**`
`30`	`30`	`* The annotation class to use for selecting classes.`
`31`	`31`	`*`
`32`		`- * @return`
	`32`	`+ * @return The annotation class.`
`33`	`33`	`*/`
`34`	`34`	`Class<? extends Annotation> value();`
`35`	`35`
`36`	`36`	`/**`
`37`	`37`	`* The package selector to use to filter selected annotated classes.`
`38`	`38`	`*`
`39`		`- * @return`
	`39`	`+ * @return The package selectors.`
`40`	`40`	`*/`
`41`	`41`	`PackageSelector[] packages() default {};`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,13 +28,14 @@`
`28`	`28`	`/**`
`29`	`29`	`* The package to use for selecting classes.`
`30`	`30`	`*`
`31`		`- * @return`
	`31`	`+ * @return The package name.`
`32`	`32`	`*/`
`33`	`33`	`String value();`
`34`	`34`
`35`	`35`	`/**`
	`36`	`+ * The pattern used to filter class names within the package.`
`36`	`37`	`*`
`37`		`- * @return`
	`38`	`+ * @return The class name pattern.`
`38`	`39`	`*/`
`39`	`40`	`String pattern() default "[a-zA-Z_$][a-zA-Z0-9_$]*";`
`40`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,9 @@`
`26`	`26`	`public @interface ResourceSelector {`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * The package to use for selecting classes.`
	`29`	`+ * The resource name to use for selecting classes.`
`30`	`30`	`*`
`31`		`- * @return`
	`31`	`+ * @return The resource name.`
`32`	`32`	`*/`
`33`	`33`	`String value();`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public String apply(String word) {`
`88`	`88`	`* Rudimentary implementation of checking whether word is plural or not.`
`89`	`89`	`* It can be further improved to handle complex cases.`
`90`	`90`	`*`
`91`		`- * @param word`
	`91`	`+ * @param word The word to check.`
`92`	`92`	`* @return Boolean value indicating whether it's already plural or not`
`93`	`93`	`*/`
`94`	`94`	`private boolean isAlreadyPlural(String word) {`