改进 sbt 文档生成
当我运行 sbt doc 时,它会生成一个不错但仍然非常基本的文档。是否可以
a)包含类定义的源文件和
b)继承继承成员的文档字符串?
我需要在项目定义中添加什么?
(这是一个 Lift 项目,因此最重要的是保留继承的 Lift 文档字符串。)
When I run sbt doc
, it results in a nice but nonetheless pretty basic documentation. Is it possible to
a) include the source files for the class definition and
b) inherit the docstrings for inherited members?
What do I need to add to my project definition?
(It’s a Lift project, so most important would be to have the inherited Lift docstrings present.)
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
a) Scala X-Ray (sxr) 将为您提供源代码作为文档。它是一个编译器插件,而且非常优秀。该链接包含 sxr+sbt 设置的链接。
b) 对不起。这件事我无能为力。
a) Scala X-Ray (sxr) will give you source code as documentation. It's a compiler plugin and it is most excellent. That link includes a link to the sxr+sbt setup.
b) I am sorry. I can't help with this one.