Copyright © 2003 Richard Carlsson
Authors: Richard Carlsson (richardc@csd.uu.se).
See also: 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_lib:edoc_env(), opts = [term()]}
abstract datatype: no_app()
A value used to mark absence of an Erlang application
context. Use the macro NO_APP
defined in
edoc_doclet.hrl
to produce this value.
run/2 | Main doclet entry point. |
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.
{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()}