-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()}

指定總覽頁面的標題。