Small docs typo (#19)

Signed-off-by: Nicolas Pierre <nicolas.pierre@artelys.com>

open-reac/src/main/java/com/powsybl/openreac/parameters/OpenReacAmplIOFiles.java

@@ -25,7 +25,7 @@
  * <p>
  * The user of OpenReac should not see this class directly. One should use {@link OpenReacParameters} for inputs
  * and {@link OpenReacResult} for outputs.
- * However, when adding new inputs (outputs) to OpenReac, one must add {@link AmplOutputFile} (@link AmplInputFile)
+ * However, when adding new inputs (outputs) to OpenReac, one must add {@link AmplInputFile} ({@link AmplOutputFile})
  * here through {@link OpenReacAmplIOFiles#getInputParameters} ({@link OpenReacAmplIOFiles#getOutputParameters})
  *
  * @author Nicolas Pierre <nicolas.pierre at artelys.com>

open-reac/src/main/java/com/powsybl/openreac/parameters/input/OpenReacParameters.java

@@ -26,22 +26,13 @@
 public class OpenReacParameters {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(OpenReacParameters.class);
-
     private static final String OBJECTIVE_DISTANCE_KEY = "ratio_voltage_target";
-
     private final Map<String, VoltageLimitOverride> specificVoltageLimits = new HashMap<>();
     private final List<String> variableShuntCompensators = new ArrayList<>();
     private final List<String> constantQGenerators = new ArrayList<>();
     private final List<String> variableTwoWindingsTransformers = new ArrayList<>();
     private final List<OpenReacAlgoParam> algorithmParams = new ArrayList<>();
     private OpenReacOptimisationObjective objective = OpenReacOptimisationObjective.MIN_GENERATION;
-
-    /*
-     * Must be used with {@link OpenReacOptimisationObjective#BETWEEN_HIGH_AND_LOW_VOLTAGE_LIMIT}
-     * to define the voltage between low and high voltage limits, which OpenReac should converge to.
-     * Zero percent means that it should converge to low voltage limits. 100 percents means that it should
-     * converge to high voltage limits.
-     */
     private Double objectiveDistance;
 
     /**
@@ -115,13 +106,21 @@ public OpenReacParameters setObjective(OpenReacOptimisationObjective objective)
         return this;
     }
 
+    /**
+     * Must be used with {@link OpenReacOptimisationObjective#BETWEEN_HIGH_AND_LOW_VOLTAGE_LIMIT}
+     * to define the voltage between low and high voltage limits, which OpenReac should converge to.
+     * <p>
+     * A 0% objective means the model will target lower voltage limit.
+     * A 100% objective means the model will target upper voltage limit.
+     */
     public Double getObjectiveDistance() {
         return objectiveDistance;
     }
 
     /**
-     * A 0% objective means the model will target lower voltage limit.
+     * Must be used with {@link OpenReacOptimisationObjective#BETWEEN_HIGH_AND_LOW_VOLTAGE_LIMIT}
      * <p>
+     * A 0% objective means the model will target lower voltage limit.
      * A 100% objective means the model will target upper voltage limit.
      * @param objectiveDistance is in %
      */
@@ -162,7 +161,7 @@ public List<OpenReacAlgoParam> getAllAlgorithmParams() {
      * Do some checks on the parameters given, such as provided IDs must correspond to the given network element
      *
      * @param network Network on which ID are going to be infered
-     * @throws InvalidParametersException
+     * @throws InvalidParametersException if the parameters contain some incoherences.
      */
     public void checkIntegrity(Network network) throws InvalidParametersException {
         for (String shuntId : getVariableShuntCompensators()) {