Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TerminalsConnectionAction: fix javadoc #3079

Merged
merged 1 commit into from
Jun 24, 2024
Merged

TerminalsConnectionAction: fix javadoc #3079

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions action-api/src/main/java/com/powsybl/action/TerminalsConnectionAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand All @@ -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) {
Expand Down