diff options
author | Paolo G. Giarrusso <p.giarrusso@gmail.com> | 2016-05-25 18:03:44 +0200 |
---|---|---|
committer | Paolo G. Giarrusso <p.giarrusso@gmail.com> | 2016-05-25 18:03:44 +0200 |
commit | 0577280bd19eafee12c590ba280916b5b9b307ad (patch) | |
tree | 0f7c5cfd4d962b660b44362b9f4c3858b9cdf105 /interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java | |
parent | d06df38c5e48ae8c957c4b71844cb850dea3a6cb (diff) | |
download | dotty-0577280bd19eafee12c590ba280916b5b9b307ad.tar.gz dotty-0577280bd19eafee12c590ba280916b5b9b307ad.tar.bz2 dotty-0577280bd19eafee12c590ba280916b5b9b307ad.zip |
Fix remaining Javadoc warnings
As a reference for how to fix warnings appropriately, I used
http://www.oracle.com/technetwork/articles/java/index-137868.html
However, I did not refrain from moving the entire JavaDoc of a method
into `@return` rather than repeating it, even though the guide (at a
quick skimming) seems to suggest otherwise.
Diffstat (limited to 'interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java')
-rw-r--r-- | interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java b/interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java index 436f9f8ea..c46360afa 100644 --- a/interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java +++ b/interfaces/src/main/java/dotty/tools/dotc/interfaces/Diagnostic.java @@ -14,13 +14,13 @@ public interface Diagnostic { public static final int WARNING = 1; public static final int INFO = 0; - /** The message to report */ + /** @return The message to report */ String message(); - /** Level of the diagnostic, can be either ERROR, WARNING or INFO */ + /** @return Level of the diagnostic, can be either ERROR, WARNING or INFO */ int level(); - /** The position in a source file of the code that caused this diagnostic + /** @return The position in a source file of the code that caused this diagnostic * to be emitted. */ Optional<SourcePosition> position(); } |