【问题标题】:Scaladoc could not find any member to link for external Java libraryScaladoc 找不到任何要链接外部 Java 库的成员
【发布时间】:2021-07-26 07:16:14
【问题描述】:

在我的 Scala 项目的文档中,我想链接到来自外部 Java 库的成员。

/**
 * Checks whether log entries at [[org.tinylog.Level.TRACE]] will be output.
 *
 * @return `true` if [[org.tinylog.Level.TRACE]] level is enabled, `false` if disabled
 */
def isTraceEnabled(): Boolean = macro TaggedLoggerMacro.isTraceEnabled

org.tinylog.Level.TRACE 是来自 Java 项目的枚举值。 IntelliJ 可以很好地解决所有这些链接,但不幸的是 scaladoc 失败了。

我的命令:

C:\bin\java\jdk-9\bin\java -Xbootclasspath/a:C:\Users\martin\.m2\repository\org\scala-lang\scala-library\2.12.9\scala-library-2.12.9.jar;C:\Users\martin\.m2\repository\org\scala-lang\scala-compiler\2.12.9\scala-compiler-2.12.9.jar;C:\Users\martin\.m2\repository\org\scala-lang\scala-reflect\2.12.9\scala-reflect-2.12.9.jar;C:\Users\martin\.m2\repository\org\scala-lang\modules\scala-xml_2.12\1.0.6\scala-xml_2.12-1.0.6.jar;C:\Users\martin\.m2\repository\org\scala-lang\scala-library\2.12.0\scala-library-2.12.0.jar -classpath C:\Users\martin\.m2\repository\net\alchim31\maven\scala-maven-plugin\4.1.1\scala-maven-plugin-4.1.1.jar scala_maven_executions.MainWithArgsInFile scala.tools.nsc.ScalaDoc C:\data\martin\TEMP\scala-maven-14328178310010851042.args

我的论点:

-doc-external-doc
"C:\tinylog 2.0\tinylog-api\target\tinylog-api-2.1-SNAPSHOT.jar#https://tinylog.org/v2/javadoc/"
-classpath
C:\Users\martin\.m2\repository\org\scala-lang\scala-library\2.12.9\scala-library-2.12.9.jar;C:\Users\martin\.m2\repository\org\scala-lang\scala-reflect\2.12.9\scala-reflect-2.12.9.jar;C:\Users\martin\.m2\repository\org\tinylog\tinylog-api\2.1-SNAPSHOT\tinylog-api-2.1-SNAPSHOT.jar
-doc-format:html
-doc-title
"tinylog Scala API 2.1-SNAPSHOT API"
-d
"C:\tinylog 2.0\tinylog-api-scala\target\site\scaladocs"
"C:\tinylog 2.0\tinylog-api-scala\src\main\scala\org\tinylog\scala\Logger.scala"
"C:\tinylog 2.0\tinylog-api-scala\src\main\scala\org\tinylog\scala\LoggerMacro.scala"
"C:\tinylog 2.0\tinylog-api-scala\src\main\scala\org\tinylog\scala\TaggedLogger.scala"
"C:\tinylog 2.0\tinylog-api-scala\src\main\scala\org\tinylog\scala\TaggedLoggerMacro.scala"

输出(总共 115 个警告):

C:\PROGS\dev\var\private\tinylog 2.0\tinylog-api-scala\src\main\scala\org\tinylog\scala\TaggedLogger.scala:242: warning: Could not find any member to link for "org.tinylog.Level.TRACE".
/**
    ^
C:\PROGS\dev\var\private\tinylog 2.0\tinylog-api-scala\src\main\scala\org\tinylog\scala\TaggedLogger.scala:229: warning: Could not find any member to link for "org.tinylog.Level.TRACE".
/**
    ^

如何正确链接到来自外部 Java 库的成员?

【问题讨论】:

标签: scala scaladoc


【解决方案1】:

正如pme 在 cmets 中提到的,scaladoc 不支持链接到 Javadoc:

scaladoc 未处理 Java 源代码中的 Javadoc cmets 或链接到 Javadoc 的结果 (https://www.scala-sbt.org/1.x/docs/Howto-Scaladoc.html)

因此,我决定使用完整的 URL 来链接来自我的外部 Java 库的枚举值。这不是很方便,但很管用。

/**
 * Checks whether log entries at [[https://tinylog.org/v2/javadoc/org/tinylog/Level.html#TRACE TRACE]] will be output.
 *
 * @return `true` if [[https://tinylog.org/v2/javadoc/org/tinylog/Level.html#TRACE TRACE]] level is enabled, `false` if disabled
 */
def isTraceEnabled(): Boolean = macro LoggerMacro.isTraceEnabled

我认为这是一种解决方法,而不是一种优雅的解决方案。欢迎任何更好的解决方案:)

【讨论】:

    猜你喜欢
    • 2014-06-01
    • 2015-10-07
    • 2011-11-13
    • 1970-01-01
    • 1970-01-01
    • 2016-10-08
    • 2012-08-15
    • 2021-09-17
    相关资源
    最近更新 更多