update to current 2.0.0-SNAPSHOT of ardoco (III)

Author: dfuchss

src/main/java/edu/kit/kastel/mcse/ardoco/tlr/rest/api/controller/AbstractController.java

@@ -97,7 +97,7 @@ protected ResponseEntity<ArdocoResultResponse> handleRunPipeLineResult(ArdocoRun
     /**
      * Handles the process of running a pipeline and waiting for the result, building a response accordingly.
      *
-     * @param runner     the {@link ArDoCoRunner} instance to execute
+     * @param runner     the {@link ArdocoRunner} instance to execute
      * @param requestId  the unique request ID associated with the pipeline run
      * @param inputFiles the list of input files for the pipeline run
      * @return a {@link ResponseEntity} containing the {@link ArdocoResultResponse} with the status and result message

src/main/java/edu/kit/kastel/mcse/ardoco/tlr/rest/api/controller/InconsistencyController.java

@@ -64,6 +64,7 @@ public InconsistencyController(InconsistencyService service) {
      * @return a ResponseEntity containing the result of the processing pipeline
      * @throws FileNotFoundException   if the provided file is empty or doesn't exist
      * @throws FileConversionException if the provided file cannot be converted
+     * @throws IOException             if an I/O error occurs during processing
      */
     @Operation(summary = "Starts the SWATTR (sad-sam) processing pipeline with Inconsistency Detection", description = "Starts the inconsistency processing pipeline with the given project name, the type of the architecture model and files.")
     @PostMapping(value = "/start", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
@@ -96,6 +97,7 @@ public ResponseEntity<ArdocoResultResponse> runPipeline(
      * @return a ResponseEntity containing the result of the processing pipeline
      * @throws FileNotFoundException   if the provided file is empty or doesn't exist
      * @throws FileConversionException if the provided file cannot be converted
+     * @throws IOException             if an I/O error occurs during processing
      */
     @Operation(summary = "Starts the SWATTR (sad-sam) processing pipeline with Inconsistency Detection and waits until the result is obtained", description = "Starts the inconsistency processing pipeline with the given project name, the type of the architecture model and files and waits until the SadSamTraceLinks and Inconsistencies are obtained.")
     @PostMapping(value = "/start-and-wait", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)

src/main/java/edu/kit/kastel/mcse/ardoco/tlr/rest/api/service/AbstractRunnerTLRService.java

@@ -28,8 +28,8 @@
  * asynchronous tasks, and interacting with a database for storing and retrieving
  * results.
  * <p>
- * Implementing classes are responsible for defining how the {@link ArDoCoResult} is
- * converted to JSON format by implementing the {@link #convertResultToJsonString(ArDoCoResult)} method.
+ * Implementing classes are responsible for defining how the {@link ArdocoResult} is
+ * converted to JSON format by implementing the {@link #convertResultToJsonString(ArdocoResult)} method.
  */
 public abstract class AbstractRunnerTLRService extends AbstractService {
 
@@ -64,7 +64,7 @@ public AbstractRunnerTLRService(TraceLinkType traceLinkType) {
     }
 
     /**
-     * Takes the {@link ArDoCoResult} and converts the contained trace links of the service's type to JSON format.
+     * Takes the {@link ArdocoResult} and converts the contained trace links of the service's type to JSON format.
      *
      * @param result the ArDoCo result containing trace links
      * @return JSON representation of trace links