[Short-circuit API] Add some javadoc. #3096
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Coline PILOQUET <coline.piloquet@rte-france.com>
So-Fras
reviewed
Jul 12, 2024
shortcircuit-api/src/main/java/com/powsybl/shortcircuit/ShortCircuitParameters.java
Outdated
Show resolved
Hide resolved
So-Fras
approved these changes
Jul 12, 2024
|
geofjamg
pushed a commit
that referenced
this pull request
Sep 18, 2024
Signed-off-by: Coline PILOQUET <coline.piloquet@rte-france.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
Docs update
What is the current behavior?
A lot of javadoc is missing.
What is the new behavior (if this is a feature change)?
I've tried to add a short description for every public class or method.
Does this PR introduce a breaking change or deprecate an API?