问题标签 [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.
lazy-evaluation - scala 是否有一个用于评估一次或从不评估的惰性 thunk 的类?
简单的东西
它是在某处定义的吗?
或者也许更复杂一点
scala - 如何消除与 scaladoc 中方法的链接的歧义?
我正在用重载方法记录一个 Scala 类。在 scaladoc 注释中引用它们时如何区分它们?例如,如果我有
然后跑sbt doc
我得到
Doc.scala:1:警告:链接目标“Doc.foo”不明确。几个(可能重载的)成员适合目标:
foo[A,B>:A](x:A):B
对象文档中的方法[已选择]foo[A]:Nothing
对象文档中的方法
对链接使用foo[A,B >: A]
etc. 不起作用。
scala - 如何让scaladoc显示默认参数值?
我有很多方法,比如
但是当我运行 scaladoc(使用 sbt)时,它没有记录runFinalizer
具有默认值的文件。这是相当有问题的,因为用户将参数设置为false
很少,并且生成的文档没有显示它可以省略。
到目前为止,我有两种解决方案,没有一种完全令人满意:
runFinalizer
记录可以在其@param
块内省略的事实。它会有所帮助,但会导致在文档中的许多地方重复这样的句子,并且用户可能会忽略它。- 创建该方法的两个变体,一个有
runFinalizers
(没有默认值),一个没有。但这会不必要地使方法数量增加一倍,并使代码和文档变得混乱。
eclipse - 如何从 Eclipse 项目生成 Scaladocs
我想从我的 Eclipse 项目开始生成 scaladocs。我不使用 SBT,但如果需要,我愿意将我的 eclipse 项目导入到 sbt。
如何从 Eclipse Scala 项目生成 Scaladocs?
scala - 有没有办法在 Scaladoc 中包含数学公式?
我想在数学 Scala 代码的 Scaladoc 文档中输入数学公式。在 Java 中,我发现了一个名为 LatexTaglet 的库,它可以通过在 Latex 中编写公式来为 Javadoc 做到这一点:http: //latextaglet.sourceforge.net/
它似乎与 Maven 很好地集成(POM 的报告/插件部分)。Scaladoc 是否有等效的库?如果没有,我如何将此库与 SBT 集成?
我也考虑过使用 MathML ( http://www.w3.org/Math/ ),但看起来太冗长了。有没有推荐的编辑器?MathML 是否与 Scaladoc 很好地集成?
谢谢您的帮助!
scala - 如何合并来自 SBT 多项目的文档?
我正在为一些 SBT 项目(在多项目配置中)生成 ScalaDoc HTML 文件。如果我在 SBT 控制台中执行doc,文档会很好地生成,但它会部署在每个项目的独立目录中。由于所有项目都相互关联(就包名称而言),我想生成一个唯一的 ScalaDoc 目录作为输出。值得一提的是,由于一些涉及的宏需要双重编译过程,我无法将所有源代码放在一起。有什么解决方法吗?
scala - 为什么浏览 Scala api 这么难?
首先,我有一个#::
Stream 的问题查找方法。从中得到了解决。
现在我正在寻找以下方法Stream
Stream API没有提及它。
其次,在 Scala Doc 中,为什么他们不能将所有内部类都定义在同一个父类本身中。为什么用户必须去点击c
左侧面板上的字符来搜索Stream.consWrapper当他可以直接在文档中阅读它Stream
本身时?
我错过了什么吗?我是 Scala 新手(3 个月),但是如果一个新用户不能习惯它,那么它大部分将无法使用。
scala - scaladoc 在哪里寻找 rootdoc.txt 来创建根文档
这是Generate scaladoc for root package的副本,但是答案没有说明在哪里sbt doc
查找rootdoc.txt
.
我添加了
到我的build.sbt
,但sbt doc
似乎没有扫描它。我试图把它放在build.sbt
, in src
, src/main
,旁边src/main/scala
我在用sbt 0.12.3
java - 如何将 JDK 中的类链接到 scaladoc 生成的文档中?
我正在尝试将 JDK 中的类链接到 scaladoc 生成的文档中。我使用了-doc-external-doc
scaladoc 2.10.1 的选项,但没有成功。
我正在使用-doc-external-doc:/usr/lib/jvm/java-7-openjdk-amd64/jre/lib/rt.jar#http://docs.oracle.com/javase/7/docs/api/
,但我得到了链接,例如index.html#java.io.File
而不是index.html?java/io/File.html
. 似乎此选项仅适用于 scaladoc 生成的文档。
我错过了 scaladoc 中的选项还是应该填写功能请求?
我已将 sbt 配置如下:
注意:我已经Opts.doc.externalAPI
在即将发布的 sbt 0.13 中看到了该 util。我认为一个很好的补充(不确定是否可能)是通过 aModuleID
而不是 a File
。该 util 将找出哪个文件对应于ModuleID
.
scala - 为什么 scaladoc 说 HashMap.toArray 返回 Array[A] 而不是 Array[(A,B)]?
我正在查看toArray
for hashmaps 的定义:
http://www.scala-lang.org/api/current/index.html#scala.collection.immutable.HashMap
它有
我不太明白这一点 - 第一部分说你得到了一个 Array[A],但第二部分说你得到了 Array[B]?这些都不是我所期望的 - Array[(A,B)]
当我自己检查时:
为什么不像 toList?