Standard doclet module for EDoc.
doclet_gen() = #doclet_gen{sources=[string()], app=no_app() | atom(), packages=[atom()], modules=[atom()], modules=[atom()], filemap=function()}
doclet_toc() = #doclet_gen{paths=[string()], indir=string()}
edoc_context() = #context{dir=string(), env=edoc_env() (see module edoc_lib), opts=[term()]}
no_app()
NO_APP
defined in
edoc_doclet.hrl
to produce this value.run(Command::doclet_gen() | doclet_toc(), Ctxt::edoc_context()) -> ok
Main doclet entry point. See the file edoc_doclet.hrl for the data structures used for passing parameters.
Also see edoc:layout/2 for layout-related options, and edoc:get_doc/2 for options related to reading source files.
Options:
{file_suffix, string()}
".html"
.
{hidden, bool()}
true
, documentation of hidden modules and
functions will also be included. The default value is false
.
{overview, edoc:filename()}
"overview.edoc"
in the target directory.
{private, bool()}
true
, documentation of private modules and
functions will also be included. The default value is false
.
{stylesheet, string()}
"stylesheet.css"
. If an empty string is
specified, no stylesheet reference will be generated.
{stylesheet_file, edoc:filename()}
"stylesheet.css"
in the priv
subdirectory of the EDoc installation directory. The named file
will be copied to the target directory.
{title, string()}