Fix java doc warnings

CHANGELOG.md

@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Fixed small issues in tests [#1400](https://github.com/ie3-institute/PowerSystemDataModel/issues/1400)
 - Fix transformer susceptance in readTheDocs to negative values [#1078](https://github.com/ie3-institute/PowerSystemDataModel/issues/1078)
-
+- Fixed `JavaDoc` warnings [#494](https://github.com/ie3-institute/PowerSystemDataModel/issues/494)
 
 ### Changed
 - Updated CI-Pipeline to run task `Deploy` and `Staging` only for `Main` [#1403](https://github.com/ie3-institute/PowerSystemDataModel/issues/1403)

build.gradle

@@ -113,7 +113,7 @@ tasks.withType(JavaCompile) {
 
 tasks.withType(Javadoc){
   options.encoding = 'UTF-8'
-  failOnError = false // TODO: Temp until JavaDoc issues are resolved
+  failOnError = true
 }
 
 tasks.register('printVersion') {

src/main/java/edu/ie3/datamodel/exceptions/ChargingPointTypeException.java

@@ -7,10 +7,21 @@
 
 /** Is thrown in case, there is some problem when building VoltageLevelInformation */
 public class ChargingPointTypeException extends Exception {
+  /**
+   * Instantiates a new Charging point type exception.
+   *
+   * @param message the message
+   */
   public ChargingPointTypeException(String message) {
     super(message);
   }
 
+  /**
+   * Instantiates a new Charging point type exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public ChargingPointTypeException(String message, Throwable cause) {
     super(message, cause);
   }

src/main/java/edu/ie3/datamodel/exceptions/ConnectorException.java

@@ -7,21 +7,37 @@
 
 /**
  * Exception that should be used whenever something invalid happens in a implementation of a {@link
- * edu.ie3.datamodel.io.connectors.DataConnector}
+ * edu.ie3.datamodel.io.connectors.DataConnector}*
  *
  * @version 0.1
  * @since 20.03.20
  */
 public class ConnectorException extends Exception {
 
+  /**
+   * Instantiates a new Connector exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public ConnectorException(final String message, final Throwable cause) {
     super(message, cause);
   }
 
+  /**
+   * Instantiates a new Connector exception.
+   *
+   * @param cause the cause
+   */
   public ConnectorException(final Throwable cause) {
     super(cause);
   }
 
+  /**
+   * Instantiates a new Connector exception.
+   *
+   * @param message the message
+   */
   public ConnectorException(final String message) {
     super(message);
   }

src/main/java/edu/ie3/datamodel/exceptions/DuplicateEntitiesException.java

@@ -8,12 +8,24 @@
 import edu.ie3.datamodel.utils.ExceptionUtils;
 import java.util.List;
 
+/** The type Duplicate entities exception. */
 public class DuplicateEntitiesException extends ValidationException {
 
+  /**
+   * Instantiates a new Duplicate entities exception.
+   *
+   * @param s the s
+   */
   public DuplicateEntitiesException(String s) {
     super(s);
   }
 
+  /**
+   * Instantiates a new Duplicate entities exception.
+   *
+   * @param entityName the entity name
+   * @param exceptions the exceptions
+   */
   public DuplicateEntitiesException(
       String entityName, List<? extends ValidationException> exceptions) {
     this(

src/main/java/edu/ie3/datamodel/exceptions/EntityProcessorException.java

@@ -7,17 +7,33 @@
 
 /**
  * Is thrown, when something went wrong during entity field mapping creation in a {@link
- * edu.ie3.datamodel.io.processor.EntityProcessor}
+ * edu.ie3.datamodel.io.processor.EntityProcessor}*
  */
 public class EntityProcessorException extends Exception {
+  /**
+   * Instantiates a new Entity processor exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public EntityProcessorException(final String message, final Throwable cause) {
     super(message, cause);
   }
 
+  /**
+   * Instantiates a new Entity processor exception.
+   *
+   * @param cause the cause
+   */
   public EntityProcessorException(final Throwable cause) {
     super(cause);
   }
 
+  /**
+   * Instantiates a new Entity processor exception.
+   *
+   * @param message the message
+   */
   public EntityProcessorException(final String message) {
     super(message);
   }

src/main/java/edu/ie3/datamodel/exceptions/ExtractorException.java

@@ -7,21 +7,37 @@
 
 /**
  * Exception that should be used whenever something invalid happens in a implementation of a {@link
- * edu.ie3.datamodel.io.connectors.DataConnector}
+ * edu.ie3.datamodel.io.connectors.DataConnector}*
  *
  * @version 0.1
  * @since 20.03.20
  */
 public class ExtractorException extends Exception {
 
+  /**
+   * Instantiates a new Extractor exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public ExtractorException(final String message, final Throwable cause) {
     super(message, cause);
   }
 
+  /**
+   * Instantiates a new Extractor exception.
+   *
+   * @param cause the cause
+   */
   public ExtractorException(final Throwable cause) {
     super(cause);
   }
 
+  /**
+   * Instantiates a new Extractor exception.
+   *
+   * @param message the message
+   */
   public ExtractorException(final String message) {
     super(message);
   }

src/main/java/edu/ie3/datamodel/exceptions/FactoryException.java

@@ -7,14 +7,30 @@
 
 /** Is thrown, when something went wrong during entity creation process in a EntityFactory */
 public class FactoryException extends RuntimeException {
+  /**
+   * Instantiates a new Factory exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public FactoryException(final String message, final Throwable cause) {
     super(message, cause);
   }
 
+  /**
+   * Instantiates a new Factory exception.
+   *
+   * @param cause the cause
+   */
   public FactoryException(final Throwable cause) {
     super(cause);
   }
 
+  /**
+   * Instantiates a new Factory exception.
+   *
+   * @param message the message
+   */
   public FactoryException(final String message) {
     super(message);
   }

src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java

@@ -8,20 +8,39 @@
 import edu.ie3.datamodel.utils.ExceptionUtils;
 import java.util.List;
 
+/** The type Failed validation exception. */
 public class FailedValidationException extends ValidationException {
+  /**
+   * Instantiates a new Failed validation exception.
+   *
+   * @param message the message
+   * @param throwable the throwable
+   */
   public FailedValidationException(String message, Throwable throwable) {
     super(message, throwable);
   }
 
+  /**
+   * Instantiates a new Failed validation exception.
+   *
+   * @param throwable the throwable
+   */
   public FailedValidationException(Throwable throwable) {
     super(throwable);
   }
 
+  /**
+   * Instantiates a new Failed validation exception.
+   *
+   * @param message the message
+   */
   public FailedValidationException(String message) {
     super(message);
   }
 
   /**
+   * Instantiates a new Failed validation exception.
+   *
    * @param exceptions List of exceptions, which must not be empty
    */
   public FailedValidationException(List<? extends Exception> exceptions) {

src/main/java/edu/ie3/datamodel/exceptions/FailureException.java

@@ -5,15 +5,32 @@
 */
 package edu.ie3.datamodel.exceptions;
 
+/** The type Failure exception. */
 public class FailureException extends Exception {
+  /**
+   * Instantiates a new Failure exception.
+   *
+   * @param message the message
+   * @param throwable the throwable
+   */
   public FailureException(String message, Throwable throwable) {
     super(message, throwable);
   }
 
+  /**
+   * Instantiates a new Failure exception.
+   *
+   * @param message the message
+   */
   public FailureException(String message) {
     super(message);
   }
 
+  /**
+   * Instantiates a new Failure exception.
+   *
+   * @param throwable the throwable
+   */
   public FailureException(Throwable throwable) {
     super(throwable);
   }

src/main/java/edu/ie3/datamodel/exceptions/FileException.java

@@ -5,11 +5,23 @@
 */
 package edu.ie3.datamodel.exceptions;
 
+/** The type File exception. */
 public class FileException extends Exception {
+  /**
+   * Instantiates a new File exception.
+   *
+   * @param message the message
+   */
   public FileException(String message) {
     super(message);
   }
 
+  /**
+   * Instantiates a new File exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public FileException(String message, Throwable cause) {
     super(message, cause);
   }

src/main/java/edu/ie3/datamodel/exceptions/GraphicSourceException.java

@@ -7,7 +7,14 @@
 
 import java.util.List;
 
+/** The type Graphic source exception. */
 public class GraphicSourceException extends SourceException {
+  /**
+   * Instantiates a new Graphic source exception.
+   *
+   * @param message the message
+   * @param exceptions the exceptions
+   */
   public GraphicSourceException(String message, List<SourceException> exceptions) {
     super(message, exceptions);
   }

src/main/java/edu/ie3/datamodel/exceptions/InvalidColumnNameException.java

@@ -12,14 +12,30 @@
  * @since 10.12.20
  */
 public class InvalidColumnNameException extends RuntimeException {
+  /**
+   * Instantiates a new Invalid column name exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public InvalidColumnNameException(final String message, final Throwable cause) {
     super(message, cause);
   }
 
+  /**
+   * Instantiates a new Invalid column name exception.
+   *
+   * @param cause the cause
+   */
   public InvalidColumnNameException(final Throwable cause) {
     super(cause);
   }
 
+  /**
+   * Instantiates a new Invalid column name exception.
+   *
+   * @param message the message
+   */
   public InvalidColumnNameException(final String message) {
     super(message);
   }

src/main/java/edu/ie3/datamodel/exceptions/InvalidEntityException.java

@@ -12,15 +12,34 @@ public class InvalidEntityException extends ValidationException {
 
   private static final long serialVersionUID = 809496087520306374L;
 
+  /**
+   * Instantiates a new Invalid entity exception.
+   *
+   * @param faultDescription the fault description
+   * @param invalidEntity the invalid entity
+   */
   public InvalidEntityException(String faultDescription, UniqueEntity invalidEntity) {
     super("Entity is invalid because of: " + faultDescription + " [" + invalidEntity + "]");
   }
 
+  /**
+   * Instantiates a new Invalid entity exception.
+   *
+   * @param faultDescription the fault description
+   * @param cause the cause
+   * @param invalidEntity the invalid entity
+   */
   public InvalidEntityException(
       String faultDescription, Throwable cause, UniqueEntity invalidEntity) {
     super("Entity is invalid because of: " + faultDescription + " [" + invalidEntity + "]", cause);
   }
 
+  /**
+   * Instantiates a new Invalid entity exception.
+   *
+   * @param message the message
+   * @param cause the cause
+   */
   public InvalidEntityException(String message, Throwable cause) {
     super(message, cause);
   }