Skip to content

Fix errors with Javadoc 8 #1278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
* 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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* You should implement this interface if you want to react to one or more of
* these events.
*
* @see the method `process` of `dotty.tools.dotc.Driver` for more information.
* See the method `process` of `dotty.tools.dotc.Driver` for more information.
*/
public interface CompilerCallback {
/** Called when a class has been generated.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
* manipulate objects of this type.
*/
public interface ReporterResult {
/** Have we emitted any error ? */
/** @return Have we emitted any error? */
boolean hasErrors();
/** Number of errors that have been emitted */
/** @return Number of errors that have been emitted */
int errorCount();

/** Have we emitted any warning ? */
/** @return Have we emitted any warning ? */
boolean hasWarnings();
/** Number of warnings that have been emitted */
/** @return Number of warnings that have been emitted */
int warningCount();
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
* You should implement this interface if you want to handle the diagnostics
* returned by the compiler yourself.
*
* @see the method `process` of `dotty.tools.dotc.Driver` for more information.
* See the method `process` of `dotty.tools.dotc.Driver` for more information.
*/
public interface SimpleReporter {
/** Report a diagnostic. */
/** Report a diagnostic.
* @param diag the diagnostic message to report
*/
void report(Diagnostic diag);
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
* manipulate objects of this type.
*/
public interface SourceFile extends AbstractFile {
/** The content of this file as seen by the compiler. */
/** @return The content of this file as seen by the compiler. */
char[] content();
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,34 @@
* 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();
}