docs: prepare javadocs generation

Author: AlexanderSchultheiss

pom.xml

@@ -66,6 +66,25 @@
                     </descriptorRefs>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.3.1</version>
+                <executions>
+                    <execution>
+                        <id>generate-javadocs</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>docs</outputDirectory>
+                            <destDir>apidocs</destDir>
+                            <show>public protected</show>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 

src/main/java/de/hub/mse/variantsync/boosting/ecco/ASTNode.java

@@ -40,12 +40,6 @@ public enum NODE_TYPE {
     /**
      * Constructs a new ASTNode with the specified parameters.
      * 
-     * @param parent   The parent ASTNode of this node. Can be null if this node is
-     *                 the root of the AST.
-     * @param code     The code snippet represented by this node.
-     * @param position The position of the code snippet in the source file.
-     * @param type     The type of the code element represented by this node.
-     * @param mapping  The formula mapping associated with this node.
      */
     public ASTNode(final ASTNode parent, final String code, final Position position, final NODE_TYPE type,
             final Formula mapping) {

src/main/java/de/hub/mse/variantsync/boosting/ecco/Association.java

@@ -81,7 +81,7 @@ public int hashCode() {
     /**
      * Returns the set of AST nodes contained in this EccoSet.
      *
-     * @return EccoSet<ASTNode> - a set of ASTNode objects representing the AST
+     * @return a set of ASTNode objects representing the AST
      *         nodes
      */
     public EccoSet<ASTNode> getAstNodes() {
@@ -161,7 +161,7 @@ public EccoSet<Module> getNot() {
     /**
      * Returns a list of the smallest min modules.
      * 
-     * @return List<Module> The list of smallest min modules
+     * @return The list of smallest min modules
      */
     public List<Module> getSmallestMinModules() {
         return getSmallestModules(this.min);
@@ -170,7 +170,7 @@ public List<Module> getSmallestMinModules() {
     /**
      * Returns a list of the smallest max modules.
      * 
-     * @return List<Module> The list of smallest max modules
+     * @return The list of smallest max modules
      */
     public List<Module> getSmallestMaxModules() {
         return getSmallestModules(this.max);

src/main/java/de/hub/mse/variantsync/boosting/ecco/Feature.java

@@ -8,8 +8,6 @@
  * 
  * This class implements the Comparable interface to allow for comparison of
  * Feature objects based on their names.
- * 
- * @param name the name of the feature
  */
 public class Feature implements Comparable<Feature>, Serializable {
 

src/main/java/de/hub/mse/variantsync/boosting/parsing/AbstractAST.java

@@ -17,10 +17,6 @@
  * with a root node and a set of AST nodes.
  * This class provides constructors to create an AST with optional filtering
  * based on file types.
- * 
- * @param root      the root node of the AST
- * @param astNodes  the set of AST nodes in the tree
- * @param fileTypes a set of file types to filter the AST nodes by
  */
 public abstract class AbstractAST implements Serializable {
     protected final ASTNode root;
@@ -73,7 +69,7 @@ public AbstractAST(final ASTNode root, final EccoSet<ASTNode> astNodes,
      * Collects all nodes (except the root node) of the Abstract Syntax Tree (AST)
      * in one set to simplify their access.
      * 
-     * @return EccoSet<ASTNode> - a set containing all nodes of the AST
+     * @return a set containing all nodes of the AST
      */
     public EccoSet<ASTNode> collectAstNodes() {
         final EccoSet<ASTNode> result = new EccoSet<>();
@@ -131,8 +127,6 @@ private void visitFile(final ASTNode parent, final File parentFile) {
      * @throws NullPointerException     if either fileNode or fileToVisit is null.
      * @throws IllegalArgumentException if the fileToVisit does not exist or is not
      *                                  a valid file.
-     * @throws IOException              if an I/O error occurs while reading the
-     *                                  file content.
      */
     protected abstract void visitFileContent(final ASTNode fileNode, final File fileToVisit);
 

src/main/java/de/hub/mse/variantsync/boosting/parsing/LineAST.java

@@ -20,14 +20,6 @@
  * content of a file and create
  * AST nodes for each line in the file.
  *
- * The visitFileContent method is overridden to visit the content of a file and
- * create AST nodes for each line in the file.
- * Each line in the file is represented by an ASTNode with the NODE_TYPE set to
- * LINE.
- *
- * @param fileNode    The ASTNode representing the file being visited.
- * @param fileToVisit The file to visit and create AST nodes for each line.
- * @throws UncheckedIOException If an IOException occurs while reading the file.
  */
 public class LineAST extends AbstractAST {
     private static final int LINE_BASE_INDEX = 0;

src/main/java/de/hub/mse/variantsync/boosting/position/ProductPosition.java

@@ -8,9 +8,6 @@
 
 /**
  * Represents a mapping between a Product and a Position.
- * 
- * @param product  The Product object associated with this ProductPosition.
- * @param position The Position object associated with this ProductPosition.
  */
 public class ProductPosition implements Serializable {
     public final Product product;

src/main/java/de/hub/mse/variantsync/boosting/product/Product.java

@@ -121,7 +121,7 @@ public EccoSet<Feature> getFeatures() {
     /**
      * Returns the set of AST nodes in the main tree.
      * 
-     * @return EccoSet<ASTNode> - a set of AST nodes in the main tree
+     * @return a set of AST nodes in the main tree
      */
     public EccoSet<ASTNode> getAstNodesMainTree() {
         return astNodesMainTree;

src/main/java/de/hub/mse/variantsync/boosting/product/ProductInitializationTask.java

@@ -21,15 +21,6 @@
 /**
  * A Callable task for initializing a product with the given parameters.
  * 
- * @param productNumber The number of the product to initialize.
- * @param productName   The name of the product to initialize.
- * @param configPath    The path to the configuration file for the product.
- * @param sourcePath    The path to the source files for the product.
- * @param allFeatures   The set of all features implemented by the product.
- * @param usedLanguage  The primary language used in the product.
- * @return An InitResult object representing the result of the initialization
- *         task.
- * @throws Exception If an error occurs during the initialization process.
  */
 public class ProductInitializationTask implements Callable<ProductInitializationTask.InitResult> {
     private final int productNumber;

src/main/java/de/hub/mse/variantsync/boosting/product/ProductLoadTask.java

@@ -13,12 +13,6 @@
  * A Callable task that loads a product from a given file path.
  * The task reads the product object from the file using ObjectInputStream and
  * returns a LoadResult object.
- * 
- * @param productPath The file path of the product to load
- * @return LoadResult An object containing the loaded product ID and product
- *         object
- * @throws UncheckedIOException If an IOException occurs while reading the file
- * @throws RuntimeException     If the Product class is not found
  */
 public class ProductLoadTask implements Callable<ProductLoadTask.LoadResult> {
     private static int processedCount = 0;