问题标签 [scaladoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
4248 浏览

scala - 在Scaladoc中,如何链接到同一个类中的方法?

在同一类中创建指向方法的链接的正确方法是什么? Scaladoc 文档没有这方面的示例。

考虑一个类,例如:

在 IntelliJ IDEA 的“快速文档”弹出窗口中,所有这些都显示为红色:

  • [[current]]
  • [[#current]]
  • [[AccountController.current]]
  • [[AccountController#current]]
  • [[controllers.AccountController.current]]

在此处输入图像描述

这确实显示为蓝色:

所以我想这是正确的,但是没有更简单但正确的方法吗?

0 投票
1 回答
1679 浏览

scala - Maven 的 Scaladoc 选项

我正在scala-maven-plugin为 Maven 寻求帮助。我想生成我的 Scaladoc,但我遇到了一些问题。

实际上,我可以输入以下命令来创建我的 Scaladoc:

现在的问题是我想在生成 Scaladoc 时添加一些选项,例如-no-link-warnings.

有谁知道如何做到这一点?我找到了一种方法(下面的代码有效),但我认为我不应该这样做。

我的pom文件是:


编辑

用户 Tunaki 在第一次回复中建议了一种更好的方法,您可以在此处查看代码。

0 投票
0 回答
142 浏览

scala - 在 Scaladoc 中继承 Scala 标准类文档

这应该是一个简单的问题,但我就是找不到明确的答案。

我正在尝试为我的项目创建一个 Scaladoc。假设我有一个类,例如:

然后我生成一个 Scaladoc,在我的 Scaladoc 文档中,我希望这个词Enumeration有一个指向当前scala.Enumeration类的链接,并从scala.Enumeration.

有可能这样做吗?如果是这样,我该怎么做?我看过这篇文章(如何从 Scala 的标准库继承 Scaladoc?),但他们用来解决问题的方法不再可行。他们谈论了 Maven 中不再起作用的解决方案(很久以前就被弃用和淘汰了)以及其他一些迫使我使用sbt而不是Maven

我正在尝试使用Maven(not sbt) 生成文档,所以我不确定这是否也会成为问题......

0 投票
1 回答
3552 浏览

scala - 有没有办法在 Scaladoc 中包含指向某些外部 HTTP URL 的超链接?

使用 Scaladoc,有没有办法包含一些外部 HTTP URL 的超链接?

使用 Javadoc 这很容易.. 但我无法弄清楚 Scaladoc 的语法。我看了这里:https ://wiki.scala-lang.org/display/SW/Writing+Documentation ,但结果很干。

假设我想在我的文档中链接到这样的外部资源 > https://en.wikipedia.org/wiki/Aardvark <。我应该使用什么标记?

0 投票
1 回答
254 浏览

scala - 在 SBT 中覆盖自动 API 映射

我有一些依赖于Cats的库。假设新的 Cats 0.4.0 版本apiURL在其 POM 中有错误的值。我不希望我的 API 文档中断,所以我提供了 URL 映射apiMappings

这适用于我的 API 文档中 Cats 类型的链接,但这意味着我丢失了标准库和其他依赖项中的类型的链接。但是,如果我更改autoAPIMappingstrue,我的自定义映射就消失了。

这对我来说没有任何意义——似乎明确定义的映射当然不应该被从依赖项 POM 中自动提取的映射覆盖。

autoAPIMappings可以为特定的依赖项使用但覆盖它吗?

0 投票
0 回答
423 浏览

scala - 无法在 BigInt 类的 scala 文档中找到方法 probablePrime()

我是 Scala 的新手,我在 BIgInt 类的 scala 文档中搜索 probablePrime() 方法。但我看不到方法。当我检查 github coce 的 BigInt.scala 时,我发现它存在。

任何人都可以让我理解为什么 scala doc 中不存在该方法。

谢谢!!

0 投票
0 回答
583 浏览

scala - Scaladoc 链接到注释块中的类的问题

我可能遗漏了一些明显的东西,但我无法让 Scaladoc 链接到类——只能链接到伴随对象。考虑这些例子。

这工作正常:

虽然这不会链接,但Could not find any member to link for "play.api.libs.json.JsObject"记录为警告:

但是,这(考虑到消歧语法链接:

我已经在 SBT 中整理了外部 API 映射,并生成了正确链接到外部站点的函数签名文档,所以我(相当)确定这与我的问题无关。

我哪里错了?(或者这是一个错误?)

0 投票
1 回答
1252 浏览

scala - Scaladoc 链接到另一种方法

我的伴侣对象(model.Product)有两种方法:

第一种方法委托给第二种方法,我想在文档中指出这一点。我尝试使用:

但是 scaladoc 抱怨说这是模棱两可的,但告诉我

是一个选项

但是我不知道如何告诉 scaladoc 使用这种方法。我试过了

但它告诉我找不到成员:

我将如何添加该def apply(p: ResultName[Product])(rs: WrappedResultSet): Product方法的链接?

0 投票
0 回答
23 浏览

scala - Scaladoc:是否可以在每个页面中插入链接?

是否可以在每个 Scaladoc 页面中插入指向我的主页的链接?有没有办法添加内容、修改布局,甚至改变每个页面的样式?

0 投票
0 回答
40 浏览

scala - HTTP请求正文的Scaladoc标签?

我正在将 Play2 与 Scala 一起使用,我想在端点 Scaladoc 中写入有关请求正文的信息。

我在Scaladoc 的文档中找不到合适的标签。什么是合适的标签?