Augmented ErrorReporter API with informational messages #1192
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
lhstrh
reviewed
May 24, 2022
org.lflang.diagram/src/org/lflang/diagram/synthesis/util/SynthesisErrorReporter.java
Outdated
Show resolved
Hide resolved
org.lflang.diagram/src/org/lflang/diagram/synthesis/util/SynthesisErrorReporter.java
Outdated
Show resolved
Hide resolved
org.lflang.diagram/src/org/lflang/diagram/synthesis/util/SynthesisErrorReporter.java
Outdated
Show resolved
Hide resolved
| @@ -94,17 +94,18 @@ private String report(String message, Severity severity, EObject obj) { | |||
| * (within the Eclipse IDE), then this also adds a marker to the editor. | |||
| * | |||
| * @param message The error message. | |||
| * @param severity One of IMarker.SEVERITY_ERROR or IMarker.SEVERITY_WARNING | |||
| * @param severity One of IMarker.SEVERITY_ERROR or IMarker.SEVERITY_WARNING or | |||
There was a problem hiding this comment.
added severity info to the comment.
| @@ -173,6 +174,16 @@ public String reportWarning(String message) { | |||
| return report(message, Severity.WARNING, null, null); | |||
| } | |||
|
|
|||
| /** | |||
| * Report an info. | |||
There was a problem hiding this comment.
Since this is an override, you could just use:
/**
* {@inheritdoc}
*/
(Or leave out the comment entirely, because I think JavaDoc is smart enough to inherit docs from the interface or super class automatically).
There was a problem hiding this comment.
comment is removed.
| @@ -115,6 +115,20 @@ public String reportWarning(String message) { | |||
| return message; | |||
| } | |||
|
|
|||
| /** | |||
| * Report the given message as a warning on the object currently under | |||
There was a problem hiding this comment.
Incorrect comment. Just leave it out because it is an override, anyway?
There was a problem hiding this comment.
comment is removed.
lhstrh
changed the title
…esisErrorReporter.java Co-authored-by: Marten Lohstroh <[email protected]>
…esisErrorReporter.java Co-authored-by: Marten Lohstroh <[email protected]>
…esisErrorReporter.java Co-authored-by: Marten Lohstroh <[email protected]>
Co-authored-by: Marten Lohstroh <[email protected]>
Co-authored-by: Marten Lohstroh <[email protected]>
Co-authored-by: Marten Lohstroh <[email protected]>
Co-authored-by: Marten Lohstroh <[email protected]>
Co-authored-by: Marten Lohstroh <[email protected]>
lhstrh
reviewed
May 24, 2022
| @@ -195,6 +201,17 @@ public String reportWarning(EObject obj, String message) { | |||
| return report(message, Severity.WARNING, obj); | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
This Javadoc comment can also be removed.
| @@ -221,6 +238,19 @@ public String reportWarning(Path file, Integer line, String message) { | |||
| return report(message, Severity.WARNING, line, file); | |||
| } | |||
|
|
|||
| /** | |||
| @@ -125,6 +132,16 @@ public String reportWarning(EObject object, String message) { | |||
| return message; | |||
| } | |||
|
|
|||
| /** | |||
| @@ -146,6 +163,18 @@ public String reportWarning(Path file, Integer line, String message) { | |||
| return fullMessage; | |||
| } | |||
|
|
|||
| /** | |||
|
repetitive comments are removed. |
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.
Fixes issue #1113. Added
reportInfotoErrorReporter.