From bdac6e1c55694f1562a56b2eb0716733bd2f1fc0 Mon Sep 17 00:00:00 2001 From: Schuyler Eldridge Date: Mon, 23 Mar 2020 18:59:38 -0400 Subject: Support Java API doc Scaladoc/Unidoc References (#1420) * Link to Java API Documentation This adds a build.sbt apiMappings to allow for Scaladoc/Unidoc linking to Java API documentation. This uses the exact strategy that Scala upstream uses for linking. Signed-off-by: Schuyler Eldridge * Add example of Java and Scala API docs linking Signed-off-by: Schuyler Eldridge Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>--- src/main/scala/firrtl/options/Exceptions.scala | 2 ++ 1 file changed, 2 insertions(+) (limited to 'src') diff --git a/src/main/scala/firrtl/options/Exceptions.scala b/src/main/scala/firrtl/options/Exceptions.scala index 38b2f2e2..3773e156 100644 --- a/src/main/scala/firrtl/options/Exceptions.scala +++ b/src/main/scala/firrtl/options/Exceptions.scala @@ -11,6 +11,8 @@ class PhaseException(val message: String, cause: Throwable = null) extends Runti /** Indicate an error related to a bad [[firrtl.annotations.Annotation Annotation]] or it's command line option * equivalent. This exception is always caught and converted to an error message by a [[Stage]]. Do not use this for * communicating generic exception information. + * @param message exception message [[scala.Predef.String String]] + * @param cause the reason for this exception (a Java [[java.lang.Throwable Throwable]]) */ class OptionsException(val message: String, cause: Throwable = null) extends IllegalArgumentException(message, cause) -- cgit v1.2.3