fix javadoc to remove warnings

Author: jra-se

ref-code-adaptation/src/main/java/de/monticore/codeAdaption/matcher/MatcherHelper.java

@@ -189,7 +189,7 @@ public static List<ISymbol> cleanReferences(List<ISymbol> references) {
       return references;
     }
 
-    Set<ISymbol> temps = new HashSet(references);
+    Set<ISymbol> temps = new HashSet<>(references);
     for (ISymbol symbol : temps) {
       for (ISymbol symbol1 : temps) {
         if (!symbol.equals(symbol1) && (matchInfix(symbol.getName(), symbol1.getName()))) {

ref-code-adaptation/src/main/java/de/monticore/codeAdaption/updater/spoonUpdater/SpoonUpdater.java

@@ -169,8 +169,15 @@ public void setOutputDirectory(Path outputPath) {
   }
 
   /***
-   *get spoonType form the Spoon Model and the mcType.
-   * save the found spoonType in the type map.
+   * Retrieves the spoonType from the Spoon Model based on the provided mcType.
+   * Saves the found spoonType in the type map.
+   *
+   * @param mcType The ASTTypeDeclaration representing the type to be searched
+   *               for in the Spoon model.
+   * @return The corresponding CtType<?> found in the Spoon model for the
+   *         given mcType.
+   * @throws AssertionError if no matching CtType<?> is found in the Spoon
+   *         model (assert will fail).
    */
   private CtType<?> getSpoonType(ASTTypeDeclaration mcType) {
     // cas already found
@@ -184,10 +191,19 @@ private CtType<?> getSpoonType(ASTTypeDeclaration mcType) {
     typeMap.put(mcType, type.get());
     return type.get();
   }
-
+  
   /***
-   *get spoonMethod form the Spoon Model and the mcType an the mcMethod.
-   * save the found spoonMethod in the type map.
+   * Retrieves the spoonMethod from the Spoon Model based on the provided
+   * mcType and mcMethod. Saves the found spoonMethod in the method map.
+   *
+   * @param mcType The ASTTypeDeclaration representing the type to which
+   *               the method belongs.
+   * @param mcMethod The ASTMethodDeclaration representing the method to be
+   *                 searched for in the Spoon model.
+   * @return The corresponding CtMethod found in the Spoon model for the
+   *         given mcType and mcMethod.
+   * @throws AssertionError if no matching CtMethod is found in the
+   *                        Spoon model (assert will fail).
    */
   public CtMethod<?> getSpoonMethod(ASTTypeDeclaration mcType, ASTMethodDeclaration mcMethod) {
     // cas method was already found
@@ -206,17 +222,30 @@ public CtMethod<?> getSpoonMethod(ASTTypeDeclaration mcType, ASTMethodDeclaratio
     methodMap.put(mcMethod, method.get());
     return method.get();
   }
-
-  /***
-   * compare a mcType an spoonType and return true if both are identical.
+  
+  /**
+   * Compares a mcType and spoonType and returns true if both are identical.
+   *
+   * @param type The ASTTypeDeclaration representing the type to be compared.
+   * @param spoonType The CtType representing the spoon type to be compared.
+   * @return True if the file name of the mcType ends with the simple name
+   *         of the spoonType followed by ".java"; otherwise false.
    */
   protected boolean compare(ASTTypeDeclaration type, CtType<?> spoonType) {
     String fileName = type.get_SourcePositionStart().getFileName().orElse(type.getName());
     return fileName.replaceAll("\\\\", ".").endsWith(spoonType.getSimpleName() + ".java");
   }
-
-  /***
-   *compare spoonMethod and  mcMethod and return true if both are identical.
+  
+  /**
+   * Compares a spoonMethod and mcMethod and returns true if both are
+   * identical.
+   *
+   * @param mcMethod The ASTMethodDeclaration representing the method to be
+   *                 compared.
+   * @param spoonMethod The CtMethod representing the spoon method to be
+   *                    compared.
+   * @return True if the names, parameter count, and parameter types of both
+   *         methods match; otherwise false.
    */
   protected boolean compare(ASTMethodDeclaration mcMethod, CtMethod<?> spoonMethod) {
     // compare names

ref-code-adaptation/src/main/java/de/monticore/codeAdaption/utils/AdapterUtils.java

@@ -47,9 +47,11 @@ public static String getPosition(SourcePosition pos) {
     }
     return "";
   }
-
-  /***
-   * read a java file an remove multilines an single lines comments.
+  
+  /**
+   * Reads a Java file and removes multi-line and single-line comments.
+   *
+   * @param file The Java file from which comments will be removed.
    */
   public static void removeComments(File file) {
 

ref-code-adaptation/src/main/java/de/monticore/codeAdaption/utils/JavaLoader.java

@@ -38,9 +38,17 @@
 import org.junit.jupiter.api.Assertions;
 
 public class JavaLoader {
-
-  /***
-   *parse a class diagram, build the symbol table and check the cocos.
+  
+  /**
+   * Parses a class diagram, builds the symbol table, and checks the
+   * consistency conditions (CoCos).
+   *
+   * @param file The class diagram file to be parsed. It must have a .cd
+   *             extension.
+   * @return The resulting ASTCDCompilationUnit created from the class
+   *         diagram.
+   * @throws AssertionError if the provided file does not have a .cd
+   *         extension, or if the AST could not be created successfully.
    */
   public static ASTCDCompilationUnit loadCD(File file) {
     // parse the class diagram
@@ -97,9 +105,13 @@ private static void createCDSymTab(ASTCDCompilationUnit ast) {
     ast.accept(c.getTraverser());
     ast.setEnclosingScope(as);
   }
-
-  /***
-   * loa a java files,transform it to an AST and creation symbol-tables.
+  
+  /**
+   * Loads a Java file, transforms it to an AST, and creates symbol tables.
+   *
+   * @param javaFile The Java file to be loaded and processed.
+   * @return The resulting ASTOrdinaryCompilationUnit created from the
+   *         Java file.
    */
   public static ASTOrdinaryCompilationUnit loadJava(File javaFile) {
     assertTrue(javaFile.getName().endsWith(".java"));
@@ -125,8 +137,13 @@ public static ASTOrdinaryCompilationUnit loadJava(File javaFile) {
 
     return (ASTOrdinaryCompilationUnit) ast.get();
   }
-
-  /** print a javaASTNode */
+  
+  /**
+   * Prints a Java ASTNode as a formatted string.
+   *
+   * @param node The ASTNode to be printed.
+   * @return A formatted string representation of the provided ASTNode.
+   */
   public static String print(ASTNode node) {
     JavaDSLFullPrettyPrinter prettyPrinter = new JavaDSLFullPrettyPrinter(new IndentPrinter());
     return prettyPrinter.prettyprint(node);
@@ -146,22 +163,24 @@ public static void writeFile(Path path, String content) {
       Log.error("Exception occur when writing the file " + path);
     }
   }
-
-  /***
-   * read recursive all java files in a directory and its subdirectories.
-   * @param directoryPath the root directory to read.
-   * @return the set of Java files as AST
+  
+  /**
+   * Reads recursively all Java files in a directory and its subdirectories.
+   *
+   * @param directoryPath The root directory to read.
+   * @return A set of Java files represented as ASTOrdinaryCompilationUnit.
    */
   public static Set<ASTOrdinaryCompilationUnit> readJavaCode(Path directoryPath) {
     Set<File> res = new HashSet<>();
     readJavaCode(directoryPath, res);
     return res.stream().map(JavaLoader::loadJava).collect(Collectors.toSet());
   }
-
-  /***
-   * read recursive all java files in a directory and its subdirectories.
-   * @param directoryPath the root directory to read.
-   * @return the set of Java files as files
+  
+  /**
+   * Reads recursively all Java files in a directory and its subdirectories.
+   *
+   * @param directoryPath The root directory to read.
+   * @return A set of Java files as File objects.
    */
   public static Set<File> readJavaFile(Path directoryPath) {
     Set<File> res = new HashSet<>();