查看源代码 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().