摘要
類型
回呼
-callback module(edoc:edoc_module(), _) -> binary().
函式
-spec module(Element, Options) -> term() when Element :: edoc:edoc_module(), Options :: options().
排版函式。
標準排版的選項
{index_columns, integer()}
- 指定用於函式索引表的欄位對數量。預設值為 1。
{pretty_printer, atom()}
- 指定如何美化列印類型和規格。如果指定值
erl_pp
,則將使用 Erlang 美化列印器(模組erl_pp
)。預設值是不進行美化列印,這意味著行可能非常長。 {stylesheet, string()}
- 指定用於引用樣式表的 URI。預設值為
"stylesheet.css"
。如果指定空字串,則不會產生樣式表引用。 {sort_functions, boolean()}
- 如果為
true
,則詳細函式描述將按名稱列出,否則它們將按原始程式碼檔案中的出現順序列出。預設值為true
。 {xml_export, Module::atom()}
- 指定一個
xmerl
回呼模組,用於匯出文件。有關詳細資訊,請參閱xmerl:export_simple/3
。
另請參閱:edoc:layout/2。