有办法让钢筋生成私有文档吗？

Question

在钢筋文档中，它指出，制作文档支持一个名为edoc_opts的选项，该选项接受edoc模块接受的选项。

在模块的doc/2函数中，它表示它接受一个选项的proplist，包括生成私有文档的{ private，true}。

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

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

然而，rebar抱怨道，命令“true}”是不理解或不适用的。

获得钢筋以生成私有文档的正确方法是什么？

Answer 1

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

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

Answer 2

答案是:要获得钢筋以生成私有文档，需要传递{private, true} in edoc_opts选项。

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

请注意，对于许多人来说，rebar.config解决方案比使用Makefile更自然。如果配置得当，您将执行rebar doc而不是make docs。