查看源码 edoc_doclet_chunks (edoc v1.3.2)

文档生成器,用于生成独立的 EEP-48 文档块文件。

EDoc 用户指南中的 使用 EDoc API 部分展示了如何使用此模块的示例。

另请参阅: edoc_layout_chunks, //stdlib/shell_docs

概要

函数

文档生成器的主要入口点。

函数

此函数的链接

run(Doclet_gen, Ctxt)

查看源码
-spec run(edoc_doclet:command(), edoc_doclet:context()) -> ok.

文档生成器的主要入口点。

此文档生成器与 edoc_layout_chunks 紧密耦合,应与其一起使用。

此文档生成器唯一接受的选项是 dir,它控制 chunks 子目录和 EEP-48 块文件放置的位置。