add scaladoc in EvalReporter

2021-07-09 08:41:24 +02:00 · 2021-07-09 08:41:24 +02:00 · ba73f87296
parent 94cc9a84ac
commit ba73f87296
1 changed files with 8 additions and 0 deletions
--- a/main-actions/src/main/scala/sbt/compiler/EvalReporter.scala
+++ b/main-actions/src/main/scala/sbt/compiler/EvalReporter.scala
@ -12,7 +12,15 @@ import scala.reflect.internal.util.Position
 import scala.tools.nsc.Settings
 import scala.tools.nsc.reporters.{ ConsoleReporter, FilteringReporter }

+/**
+ * Reporter used to compile *.sbt files that forwards compiler diagnostics to BSP clients
+ */
 abstract class EvalReporter extends FilteringReporter {
+
+  /**
+   * Send a final report to clear out the outdated diagnostics.
+   * @param sourceName a *.sbt file
+   */
  def finalReport(sourceName: String): Unit
 }