Link ScalaDoc 中的 Scala 注释

Question

在 ScalaDoc 中，我想要 link 来自库的注释：discriminator.

我的 ScalaDoc：

/** Trait must be marked with [[json.schema.discriminator]] annotation. */

但是 ScalaDoc 生成失败并出现以下错误：

Could not find any member to link for "json.schema.discriminator".

更新：错误似乎是因为 -Xfatal-warnings scalac 选项。

弄清楚后，我找到了 sbt-api-mappings SBT 插件，它使用 javadoc.io 解析所有外部引用。

Answer 1

您可能没有找到它，因为您没有导入正确的包。请注意 json.schema.discriminator class 是 "scala-jsonschema-core" 包的一部分。

因此您需要添加到您的 build.sbt:

name := "Whosebug"
version := "0.1"
scalaVersion := "2.13.6"

libraryDependencies += "com.github.andyglow" %% "scala-jsonschema-core" % "0.7.6"
libraryDependencies += "com.github.andyglow" %% "scala-jsonschema-core" % "0.7.6" classifier "javadoc"

然后你就可以像你试过的那样使用它了：

/** Trait must be marked with [[json.schema.discriminator]] annotation. */

然后 sbt doc 有效：

Link ScalaDoc 中的 Scala 注释

Link Scala annotation in ScalaDoc

scala

scaladoc