Add missing javadoc for return and throws

GeoWerkstatt · Dec 6, 2023 · f160133 · f160133
1 parent a87f45e
commit f160133
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/src/main/java/ch/geowerkstatt/interlis/testbed/runner/Runner.java b/src/main/java/ch/geowerkstatt/interlis/testbed/runner/Runner.java
@@ -22,6 +22,7 @@ public Runner(TestOptions options, Validator validator) {
 
     /**
      * Runs the testbed validation.
+     * @return {@code true} if the validation was successful, {@code false} otherwise.
      */
     public boolean run() {
         LOGGER.info("Starting validation of testbed at " + options.basePath());

diff --git a/src/main/java/ch/geowerkstatt/interlis/testbed/runner/Validator.java b/src/main/java/ch/geowerkstatt/interlis/testbed/runner/Validator.java
@@ -8,6 +8,7 @@ public interface Validator {
      *
      * @param filePath the path to the file to validate.
      * @return true if the validation was successful, false otherwise.
+     * @throws ValidatorException if the validation could not be performed.
      */
     boolean validate(Path filePath) throws ValidatorException;
 }