Copyright © 2003 Richard Carlsson
Authors: Richard Carlsson (richardc@csd.uu.se).
See also: edoc.
run/2 | Main doclet entry point. |
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()}