documentation - 有没有办法让钢筋生成私人文档？

Question

在 rebar 文档中，它说制作文档支持一个名为 edoc_opts 的选项，它接受edoc 模块接受的选项。

在模块对 get_doc/2 函数的描述中，它说它接受一个选项列表，包括 {private, true} 来生成私有文档。

在我的 Makefile 中，我有以下内容：

docs:
    rebar skip_deps=true edoc_opts=[{private, true}] doc

但是，rebar 抱怨说命令“true}]”不被理解或不适用。

让钢筋生成私人文档的正确方法是什么？

score 2 · Accepted Answer

将选项放在rebar.config 文件中，每一行都是for {tool,[optionList]} 的一个元组。：

{edoc_opts,[{todo,true},{private,true}]}.

score 0 · Accepted Answer

答案就在问题中：要让 rebar 生成私有文档，您需要传入option {private, true}。edoc_opts

您可以在 rebar.config 文件或命令行中传递此选项，就像在 Makefile 中一样。在这种情况下，您应该转义空格或引用参数。否则，rebar 将得到edoc_opts=[{private,和true}]作为两个参数。

请注意，该rebar.config解决方案对许多人来说比使用 Makefile 更自然。正确配置，你会做rebar doc而不是make docs.

2 回答 2