ScalaDoc中的Link Scala注解

Question

在ScalaDoc中，我希望有一个指向库中注释的链接：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标量选项造成的。

一旦弄清楚了，我找到了一个用javadoc.io解析所有外部引用的sbt-api-mappings SBT插件。

Answer 1

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

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

name := "StackOverflow"
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就可以工作了：

​

​