2013-08-09 3 views
0

철근 문서에서 설명서 만들기에는 edoc_opts라는 옵션이 지원되며 이는 edoc module에서 허용하는 옵션을 허용합니다.Rebar가 개인 문서를 생성하는 방법이 있습니까?

모듈의 description of the get_doc/2 function에서는 개인 문서를 생성하기 위해 {private, true}를 포함한 옵션의 프로 프리스트를 허용한다고합니다. 내 메이크에서

, 나는 다음과 같은 한 :

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

그러나, 철근은 불평 명령 "사실}]"이해 나 적용되지 않는다는 말.

보강 철근에 개별 문서를 생성하는 올바른 방법은 무엇입니까?

답변

1

옵션을 rebar.config 파일에 넣으면 각 줄은 for {tool, [optionList]}의 튜플입니다. :

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

감사합니다. 정확히 내가 필요한 것. –

0

대답은 질문에 : 철근 개인 문서를 생성하는 얻을, 당신은 edoc_opts 옵션에 {private, true}을 통과해야합니다.

이 옵션은 Makefile에서와 같이 rebar.config 파일이나 명령 줄에서 전달할 수 있습니다. 이 경우 또는 의 인수를으로 이스케이프해야합니다. 그렇지 않으면 보강 철근은 edoc_opts=[{private,true}]이 두 개의 인수로 사용됩니다.

rebar.config 솔루션은 Makefile을 사용하는 것보다 자연스럽게 느껴집니다. 올바르게 구성하면 make docs 대신 rebar doc을 사용합니다.