檢視原始碼 edoc_run (edoc v1.3.2)

從 Erlang 啟動選項呼叫 EDoc 的介面。

以下是 Makefile 中典型用法的範例

     docs:
             erl -noshell -run edoc_run application "'$(APP_NAME)'" \
               '"."' '[{def,{vsn,"$(VSN)"}}]'

(請注意單引號可避免 shell 展開，以及雙引號括住字串)。

0.6.9 版的新功能：不再需要在命令列最後寫入 -s init stop 以使執行終止。終止（向作業系統發出成功或失敗的訊號）現在已內建於這些函式中。

另請參閱：edoc。

摘要

類型

args/0

函式

application(Args)

使用相應的引數呼叫 edoc:application/3。列表中的字串會被解析為 Erlang 常數項。此列表可以是 [App]、[App, Options] 或 [App, Dir, Options]。在第一種情況下，會改為呼叫 edoc:application/1；在第二種情況下，會呼叫 edoc:application/2。

file(Args) 已棄用

使用相應的引數呼叫 edoc:file/2。列表中的字串會被解析為 Erlang 常數項。此列表可以是 [File] 或 [File, Options]。在第一種情況下，會將空選項列表傳遞給 edoc:file/2。

files(Args)

使用相應的引數呼叫 edoc:files/2。列表中的字串會被解析為 Erlang 常數項。此列表可以是 [Files] 或 [Files, Options]。在第一種情況下，會改為呼叫 edoc:files/1。

類型

連結到此類型

args/0

檢視原始碼 
-type args() :: [string()].

函式

連結到此函式

application(Args)

檢視原始碼 
-spec application(args()) -> no_return().

使用相應的引數呼叫 edoc:application/3。列表中的字串會被解析為 Erlang 常數項。此列表可以是 [App]、[App, Options] 或 [App, Dir, Options]。在第一種情況下，會改為呼叫 edoc:application/1；在第二種情況下，會呼叫 edoc:application/2。

函式呼叫永遠不會回傳；相反地，當呼叫完成時，模擬器會自動終止，並向作業系統發出成功或失敗的訊號。

連結到此函式

file(Args)

檢視原始碼
此函式已棄用。這是 EDoc 的舊介面的一部分，主要為了保持向後相容性而保留。產生文件的首選方法是透過函式 application/1 和 files/1 之一。
-spec file(args()) -> no_return().

使用相應的引數呼叫 edoc:file/2。列表中的字串會被解析為 Erlang 常數項。此列表可以是 [File] 或 [File, Options]。在第一種情況下，會將空選項列表傳遞給 edoc:file/2。

以下是 Makefile 中典型用法的範例

     $(DOCDIR)/%.html:%.erl
             erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \
               -s init stop

函式呼叫永遠不會回傳；相反地，當呼叫完成時，模擬器會自動終止，並向作業系統發出成功或失敗的訊號。

連結到此函式

files(Args)

檢視原始碼 
-spec files(args()) -> no_return().

使用相應的引數呼叫 edoc:files/2。列表中的字串會被解析為 Erlang 常數項。此列表可以是 [Files] 或 [Files, Options]。在第一種情況下，會改為呼叫 edoc:files/1。

函式呼叫永遠不會回傳；相反地，當呼叫完成時，模擬器會自動終止，並向作業系統發出成功或失敗的訊號。