生成不含JavaScript的Scala API文档,但是静态HTML或Markdown

0__*_*0__ 9 scala scaladoc

对于应用程序内帮助浏览器,我想呈现API文档.不幸的是,Scaladoc似乎只生成充满了可怕的JavaScript内容的HTML文件,因此即使使用相当重的组件(例如SwingBox(虽然它确实具有非常好的CSS))也无法呈现这些文件.

所以我的问题是:我可以利用Scaladoc工具或其API(如果有的话)生成一些中间表示,然后我可以将其写入自定义Markdown文件或静态HTML页面吗?

met*_*sim 9

您正在寻找的是一个自定义Doclet实现,可以通过-doc-generator命令行选项使用scaladoc.我不能回答一个预先存在的Doclet实现是否会满足您的需求,但是一个有前景的实现是Extradoc.但是,它在一段时间内没有更新.

在较低级别,您可以通过子类化Doclet和关联的API(例如HTMLFactory,和Template)实现自己的API .除了Extradoc 1之外,似乎没有任何/很多例子可以做到这一点.不幸的是,看起来ScalaDoc在这方面没有像JavaDoc那样得到同样的关注.根据这些发行说明,2.12具有改进的ScalaDoc接口,但我认为它不会改变对JavaScript的依赖性.

我还遇到了Nyandoc,它将ScalaDoc和JavaDoc转换为Markdown.也许作为一种直接的格式,它可以让你更接近你的目标.

总而言之,是在使用JavaFX WebView组件吗?它有一个完整的WebKit浏览器和JS引擎,它可以在Swing中嵌入JavaFX组件.