summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorSchuyler Eldridge2020-03-30 18:03:14 -0400
committerGitHub2020-03-30 22:03:14 +0000
commita18515b79bd90e7296451c7cc0bb08834c1b7aca (patch)
treecb82548ad8223817a2b970b0744291b84880e997 /core
parent8903cb10073b22ab7a3313853d1a627fc22dcccf (diff)
Java API Documents Linking (#1367)
* Show linking against Javadoc Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> * Add sbt-api-mappings plugin This adds the sbt-api-mappings plugin which enables auto-linking (properly setting the apiMappings for the sbt project) so that Scaldoc/unidoc generation will now automatically link against Java and Scala API docs (and use the right version). Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com> * Show linking against Scala APIs Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Diffstat (limited to 'core')
-rw-r--r--core/src/main/scala/chisel3/package.scala2
1 files changed, 1 insertions, 1 deletions
diff --git a/core/src/main/scala/chisel3/package.scala b/core/src/main/scala/chisel3/package.scala
index 65bfdeb7..cf0afb10 100644
--- a/core/src/main/scala/chisel3/package.scala
+++ b/core/src/main/scala/chisel3/package.scala
@@ -11,7 +11,7 @@ package object chisel3 { // scalastyle:ignore package.object.name
import scala.language.implicitConversions
/**
- * These implicit classes allow one to convert scala.Int|scala.BigInt to
+ * These implicit classes allow one to convert [[scala.Int]] or [[scala.BigInt]] to
* Chisel.UInt|Chisel.SInt by calling .asUInt|.asSInt on them, respectively.
* The versions .asUInt(width)|.asSInt(width) are also available to explicitly
* mark a width for the new literal.