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/AbstractFile.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/AbstractFile.java')
-rw-r--r-- | interfaces/src/main/java/dotty/tools/dotc/interfaces/AbstractFile.java | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/interfaces/src/main/java/dotty/tools/dotc/interfaces/AbstractFile.java b/interfaces/src/main/java/dotty/tools/dotc/interfaces/AbstractFile.java index a1b9cc5c7..286e7b2cf 100644 --- a/interfaces/src/main/java/dotty/tools/dotc/interfaces/AbstractFile.java +++ b/interfaces/src/main/java/dotty/tools/dotc/interfaces/AbstractFile.java @@ -11,13 +11,13 @@ import java.util.Optional; * manipulate objects of this type. */ public interface AbstractFile { - /** The name of this file, note that two files may have the same name. */ + /** @return The name of this file, note that two files may have the same name. */ String name(); - /** The path of this file, this might be a virtual path of an unspecified format. */ + /** @return The path of this file, this might be a virtual path of an unspecified format. */ String path(); - /** If this is a real file on disk, a `java.io.File` that corresponds to this file. + /** @return If this is a real file on disk, a `java.io.File` that corresponds to this file. * Otherwise, an empty `Optional`. */ Optional<File> jfile(); |