Remove apiNote since Javadoc doesn't accept it

sbt · May 21, 2017 · 73ff81a · 73ff81a
1 parent 761ea0e
commit 73ff81a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/internal/compiler-bridge/src/main/scala_2.10/xsbt/Compat.scala b/internal/compiler-bridge/src/main/scala_2.10/xsbt/Compat.scala
@@ -1,5 +1,6 @@
 package xsbt
 
+import xsbti.compile.Output
 import scala.reflect.{ internal => sri }
 import scala.reflect.internal.{ util => sriu }
 import scala.tools.nsc.{ Global, Settings }

diff --git a/internal/compiler-interface/src/main/java/xsbti/compile/analysis/ReadStamps.java b/internal/compiler-interface/src/main/java/xsbti/compile/analysis/ReadStamps.java
@@ -28,10 +28,11 @@ public interface ReadStamps {
 
     /**
      * Retrieves the stamp associated with a given internal source.
+     * <p>
+     * Note that the internal source has to be a source under compilation.
      *
      * @param internalSource The source file under compilation.
      * @return The stamp for the file.
-     * @apiNote The internal source has to be a source under compilation.
      * @see xsbti.AnalysisCallback#startSource(File)
      */
     public Stamp source(File internalSource);
@@ -63,11 +64,11 @@ public interface ReadStamps {
 
     /**
      * Returns a map of all the stamps associated with product files.
-     *
-     * @apiNote The returned map can be empty if no compilation has happened yet
-     * (e.g. compile analysis is empty).
+     * <p>
+     * Note that the returned map can be empty if no compilation has happened yet.
      *
      * @return A map of product files to stamps.
+     * (e.g. compile analysis is empty).
      * @see xsbti.compile.analysis.ReadStamps#product(File)
      */
     public Map<File, Stamp> getAllProductStamps();

diff --git a/internal/compiler-interface/src/main/java/xsbti/compile/analysis/SourceInfo.java b/internal/compiler-interface/src/main/java/xsbti/compile/analysis/SourceInfo.java
@@ -8,17 +8,19 @@
 public interface SourceInfo {
     /**
      * Returns the reported problems by the Java or Scala compiler.
+     * <p>
+     * Note that a reported problem is a problem that has been shown to the end user.
      *
      * @return The compiler reported problems.
-     * @apiNote A reported problem is a problem that has been shown to the end user.
      */
     public Problem[] getReportedProblems();
 
     /**
      * Returns the unreported problems by the Java or Scala compiler.
+     * <p>
+     * Note that an unreported problem is a problem that has not been shown to the end user.
      *
      * @return The compiler reported problems.
-     * @apiNote An unreported problem is a problem that has not been shown to the end user.
      */
     public Problem[] getUnreportedProblems();
 }