Fix java doc warnings #1413
Open
Fix java doc warnings #1413
Conversation
This file contains hidden or 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
# Conflicts: # CHANGELOG.md
danielfeismann
requested review from
sebastian-peter and
staudtMarius
as code owners
staudtMarius
requested changes
Aug 8, 2025
| @@ -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}* | |||
| /** | ||
| * Instantiates a new Duplicate entities exception. | ||
| * | ||
| * @param s the s |
There was a problem hiding this comment.
This should be renamed into something like the message. Maybe we should also rename the parameter.
| @@ -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}* | |||
| /** | ||
| * Instantiates a new Topology exception. | ||
| * | ||
| * @param s the s |
There was a problem hiding this comment.
Should probably be renamed.
| /** | ||
| * Instantiates a new Topology exception. | ||
| * | ||
| * @param s the s |
Comment on lines
+16
to
17
| /** The type Hp input factory. */ | ||
| public class HpInputFactory |
Comment on lines
+24
to
25
| /** The type Load input factory. */ | ||
| public class LoadInputFactory |
| @@ -45,6 +50,18 @@ protected T buildModel( | |||
| return buildModel(data, uuid, id, nodeA, nodeB, operator, operationTime); | |||
| } | |||
|
|
|||
| /** | |||
| * Build model t. | |||
There was a problem hiding this comment.
The t should be replaced (maybe instance).
Comment on lines
+14
to
15
| /** The type Cylindrical storage input factory. */ | ||
| public class CylindricalStorageInputFactory |
Comment on lines
+17
to
18
| * @param <T> the type parameter | ||
| * @version 0.1 |
|
@staudtMarius I'm sorry, I should have written something about this beforehand. But I didn't expect someone to review this so quickly and in such depth. Most of it is generated automatically. There will certainly be improvements. There are now three options:
Let's discuss this in office / sprint somewhen. |
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.
resolves #494
merge first