-spec run(edoc_doclet:command(), edoc_doclet:context()) -> ok.

主要的 doclet 入口点。有关用于传递参数的数据结构，请参阅文件 edoc_doclet.hrl。

另请参阅 edoc:layout/2，了解与布局相关的选项，以及 edoc:get_doc/2，了解与读取源文件相关的选项。

选项

{file_suffix, string()}

指定用于输出文件的后缀。默认值为 ".html"。

{hidden, boolean()}

如果该值为 true，则还会包含隐藏模块和函数的文档。默认值为 false。

{overview, edoc:filename()}

指定概述文件的名称。默认情况下，此 doclet 在目标目录中查找文件 "overview.edoc"。

{private, boolean()}

如果该值为 true，则还会包含私有模块和函数的文档。默认值为 false。

{stylesheet, string()}

指定用于引用样式表的 URI。默认值为 "stylesheet.css"。如果指定空字符串，则不会生成样式表引用。

{stylesheet_file, edoc:filename()}

指定样式表文件的名称。默认情况下，此 doclet 使用 EDoc 安装目录的 priv 子目录中的文件 "stylesheet.css"。指定的文件将被复制到目标目录。

{title, string()}

指定概述页面的标题。