问题标签 [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 投票
1 回答
566 浏览

scala - 如何在scaladoc的Object类中引用val的名称?

有没有一种方法可以使用 scaladoc 在 Object 类中引用 val 的名称,类似于

在 javadoc 中。

0 投票
1 回答
529 浏览

scala - Scaladoc 无法为方法和类签名中的内部类生成链接

我有一个顶级特征,其中包含许多类和特征,例如:

当我为它生成文档时,使用 scaladoc 我可以使用 [[CLASS_NAME]] 链接到内部类,但是 scaladoc 无法在签名和扩展中为树创建链接。

我使用 sbt 生成 scaladoc,并使用以下标志:

为了让您更好地了解,上述定义的api如下(请注意缺少的链接):

在此处输入图像描述

你能告诉我我做错了什么吗?

0 投票
1 回答
492 浏览

eclipse - Eclipse Scala 插件未显示 Scala 项目中的类和方法的文档

我通过eclipse(Mars)安装了scala插件,在文档方面遇到了问题。当我创建一个新的 Java 项目并编写代码时,我会像往常一样将鼠标悬停在类及其方法上时获得文档。

但是,当我制作一个新的 Scalaproject 时,它不起作用。例如:

现在,当我将鼠标悬停在 String 或 charAt 上时,我只会得到

在出现的小盒子里。请注意,不仅 Java 类及其方法没有任何文档,Scala 方法和类也没有任何文档。

我已经尝试重新安装整个设置以及使用可以直接从Scala IDE 下载的 Scala IDE

我发现了其他问题,但是它们都来自一年前或更早,并且在那段时间有一个错误。然而,这个错误很久以前就被设置为修复。

起作用的是在方法和类之上自制的scaladoc,但仅此而已。

谁能帮我解决这个问题?Javadoc 路径也在 rt.jar 中设置,所以我真的没有想法。

谢谢!

更新 我尝试了以下方法:

并获得了一些方法的文档,如“应用”等。但是,当我将鼠标悬停在字符串上时,我仍然没有得到任何文档,如下所示:Scala IDE 介绍视频

我得到的是

不是很有帮助...

0 投票
2 回答
2272 浏览

scala - Scaladoc (2.11.6) 在 throws 标记上失败,并带有“无法找到任何要链接的成员”

在尝试通过sbt "++2.11.6 publishLocal"或为我的项目发布 jarsbt +publishLocal时,我在为 Scala 2.11.6 发布时遇到了 Scaladoc 问题。看来我有由@throws标签引起的无效链接。我不确定为什么我的链接无效,也不确定为什么错误只发生在 Scala 2.11.6 而不是 Scala 2.10.5 在我的交叉发布期间。我找不到任何迹象表明@throwsScala 2.11 不支持该标签;所以,我假设这是我的 Scaladoc 的问题,但我不知道此时我缺少什么。谁能给我一些关于这个问题的见解?

上面的片段(报告的问题之一)是我的项目文件的一部分:https ://github.com/rcsenkbeil/scala-debugger/blob/master/scala-debugger-api/src/main/scala/ org/senkbeil/debugger/Debugger.scala#L22

Scaladoc的实际编译错误系列如下:

0 投票
1 回答
1076 浏览

scala - 在 scaladoc 中添加代码示例

在 ScalaDoc 中添加代码示例的标准约定(或标记)是什么?下面代码中的示例,我想提供编码示例来演示它的用法:

就像在 javadocs 中一样,使用了@code

0 投票
1 回答
105 浏览

scala - 在 scaladoc 中链接到 [[importedName]],而不是完全限定名称

如何在 scaladoc 中创建指向某些导入名称(在另一个包中)的链接,而不必使用完全限定名称?

例子:

文件 1

文件 2

但我不想在 doc 中有[[com.pany.pck1.subpck.Class1]]

如有必要,我不介意在 Class2 文档末尾添加 ref,例如

0 投票
1 回答
1019 浏览

scala - Scaladoc 图

是否可以使用 Scaladoc 和 SBT 生成图表?

我试图在我的build.sbt scalacOptions in (Compile,doc) := Seq("-diagrams", "-diagrams-debug")

但我收到:图表生成运行时间细分:

如何获取有关“损坏的图像”的更多日志?

谢谢。

编辑:

该命令last向我显示:

0 投票
0 回答
245 浏览

scala - Scaladoc、SBT 和案例类以及 scala 版本 2.11.x

在带有案例类的 Intellij IDEA SBT 项目中为 scala 2.11.7 生成 scaladoc 时遇到问题。例如,使用以下代码:

当我尝试生成 scaladoc 时,抛出异常:错误:

在此示例中,scaladoc 已成功生成,但在我拥有的另一个大项目中,也引发了此错误并且没有生成任何内容。这可能是 sbt 使用 2.10.4 和我的项目使用 2.11.7 的问题吗?

0 投票
0 回答
173 浏览

scala - 如何为子目录中的文件递归地生成scaladoc

我正在使用 {scaladoc} 为我的 scala 文件生成文档,是否可以从子目录中的文件生成?

0 投票
2 回答
955 浏览

scala - 如何使用 Scala 修改 Intellij IDEA 中的块注释对齐方式?

目前,当 Intellij IDEA 自动完成块注释时,例如打字/**+<return>,IDEA 将创建一个块注释,如下所示:

/** * Comment goes here */

但是,scaladoc 建议块注释正文以不同的方式对齐:

/** * Comment here */ (注意空格的区别)。

这是如何配置的?