在钢筋文档中,它表示制作文档支持名为edoc_opts的选项,该选项接受edoc module接受的选项。
在模块的description of the get_doc/2 function中,它表示接受选项的列表,包括{private,true}以生成私人文档。
在我的Makefile中,我有以下内容:
docs:
rebar skip_deps=true edoc_opts=[{private, true}] doc
然而,钢筋抱怨说,命令“true}]”不被理解或适用。
获取钢筋生成私人文档的正确方法是什么?
答案 0 :(得分:1)
将选项放在rebar.config文件中,每一行都是for for {tool,[optionList]}的元组。 :
{edoc_opts,[{todo,true},{private,true}]}.
答案 1 :(得分:0)
问题的答案是:要获得rebar来生成私人文档,您需要在{private, true}
选项中传递edoc_opts
。
您可以像在Makefile中一样在rebar.config文件或命令行中传递此选项。在这种情况下,您应该逃避空间或引用参数。否则,钢筋会将edoc_opts=[{private,
和true}]
作为两个参数。
请注意,rebar.config
解决方案比使用Makefile更自然。如果配置正确,您可以rebar doc
代替make docs
。