TerminalsConnectionAction: fix javadoc (#3079)

Signed-off-by: Anne Tilloy <anne.tilloy@rte-france.com>
powsybl · Sep 18, 2024 · 573a27c · 573a27c
1 parent 309d05e
commit 573a27c
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/action-api/src/main/java/com/powsybl/action/TerminalsConnectionAction.java b/action-api/src/main/java/com/powsybl/action/TerminalsConnectionAction.java
@@ -27,9 +27,10 @@ public class TerminalsConnectionAction extends AbstractAction {
 
     /**
      * @param id the id of the action.
-     * @param elementId the id of the element which terminals are operated.
-     *                  The element can be any connectable, including a tie line by referring the terminal of
-     *                  an underlying dangling line.
+     * @param elementId the id of the connectable which terminals are operated.
+     *                  As a tie line (respectively an hvdc line) is not a connectable, opening or closing a tie line
+     *                  (respectively an hvdc line) on both sides is done through two {@link TerminalsConnectionAction},
+     *                  each one referring to one of the underlying dangling lines (respectively converter stations).
      * @param side the side of the element to operate in the action.
      * @param open the status for the terminal to operate. {@code true} means terminal opening.
      */
@@ -42,9 +43,10 @@ public TerminalsConnectionAction(String id, String elementId, ThreeSides side, b
 
     /**
      * @param id the id of the action.
-     * @param elementId the id of the element which terminals are operated.
-     *                  The element can be any connectable, including a tie line by referring the terminal of
-     *                  an underlying dangling line.
+     * @param elementId the id of the connectable which terminals are operated.
+     *                  As a tie line (respectively an hvdc line) is not a connectable, opening or closing a tie line
+     *                  (respectively an hvdc line) on both sides is done through two {@link TerminalsConnectionAction},
+     *                  each one referring to one of the underlying dangling lines (respectively converter stations).
      * @param open the status for all the terminals of the element to operate. {@code true} means all terminals opening.
      */
     public TerminalsConnectionAction(String id, String elementId, boolean open) {