檢視原始碼 edoc_layout 行為 (edoc v1.3.2)

EDoc 的標準 HTML 排版模組。有關使用方式的詳細資訊,請參閱 edoc 模組。

另請參閱:edoc

摘要

回呼

排版入口點。

類型

-type options() ::
          [{index_columns, integer()} |
           {pretty_printer, atom()} |
           {stylesheet, string()} |
           {sort_functions, boolean()} |
           {xml_export, module()}].

回呼

-callback module(edoc:edoc_module(), _) -> binary().
排版入口點。

函式

連結到此函式

module(Element, Options)

檢視原始碼
-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

連結到此函式

overview(Element, Options)

檢視原始碼
-spec overview(Element :: term(), Options :: options()) -> term().
-spec type(Element :: term()) -> term().