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/SourcePosition.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/SourcePosition.java')
-rw-r--r-- | interfaces/src/main/java/dotty/tools/dotc/interfaces/SourcePosition.java | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/interfaces/src/main/java/dotty/tools/dotc/interfaces/SourcePosition.java b/interfaces/src/main/java/dotty/tools/dotc/interfaces/SourcePosition.java index c9b42d4ad..d8afbf5f6 100644 --- a/interfaces/src/main/java/dotty/tools/dotc/interfaces/SourcePosition.java +++ b/interfaces/src/main/java/dotty/tools/dotc/interfaces/SourcePosition.java @@ -12,33 +12,34 @@ package dotty.tools.dotc.interfaces; * manipulate objects of this type. */ public interface SourcePosition { - /** Content of the line which contains the point */ + /** @return Content of the line which contains the point */ String lineContent(); - /** Offset to the point */ + /** @return Offset to the point */ int point(); - /** Line number of the point, starting at 0 */ + /** @return Line number of the point, starting at 0 */ int line(); - /** Column number of the point, starting at 0 */ + /** @return Column number of the point, starting at 0 */ int column(); - /** Offset to the range start */ + /** @return Offset to the range start */ int start(); - /** Line number of the range start, starting at 0 */ + /** @return Line number of the range start, starting at 0 */ int startLine(); - /** Column number of the range start, starting at 0 */ + /** @return Column number of the range start, starting at 0 */ int startColumn(); - /** Offset to the range end */ + /** @return Offset to the range end */ int end(); - /** Line number of the range end, starting at 0 */ + /** @return Line number of the range end, starting at 0 */ int endLine(); - /** Column number of the range end, starting at 0 */ + /** @return Column number of the range end, starting at 0 */ int endColumn(); /** The source file corresponding to this position. * The values returned by `point()`, `start()` and `end()` * are indices in the array returned by `source().content()`. + * @return source file for this position */ SourceFile source(); } |