proplist() = [term()]

syntaxTree() = syntaxTree() (see module //syntax_tools/erl_syntax)

file(Name::filename()) -> ok

file(Name::filename(), Options::proplist()) -> ok

This function is deprecated: This is part of the old interface to EDoc and is mainly
kept for backwards compatibility. The preferred way of generating
documentation is through one of the functions application/2,
packages/2 and files/2.

Reads a source code file and outputs formatted documentation to
a corresponding file.

Options:

{dir, filename()}

Specifies the output directory for the created file. (By
default, the output is written to the directory of the source
file.)

{source_suffix, string()}

Specifies the expected suffix of the input file. The default
value is ".erl".

{file_suffix, string()}

Specifies the suffix for the created file. The default value is
".html".

packages(Packages::[package()]) -> ok

packages(Packages::[package()], Options::proplist()) -> ok

Runs EDoc on a set of packages. The source_path option is used
to locate the files; see run/3 for details, including
options. This function automatically appends the current directory to
the source path.

Specifies a list of URI:s pointing to directories that contain
EDoc-generated documentation. URI without a scheme:// part are
taken as relative to file://. (Note that such paths must use
/ as separator, regardless of the host operating system.)

{doclet, Module::atom()}

Specifies a callback module to be used for creating the
documentation. The module must export a function run(Cmd, Ctxt).
The default doclet module is edoc_doclet; see edoc_doclet:run/2 for doclet-specific options.

{exclude_packages, [package()]}

Lists packages to be excluded from the documentation. Typically
used in conjunction with the subpackages option.

{file_suffix, string()}

Specifies the suffix used for output files. The default value is
".html". Note that this also affects generated references.

{new, boolean()}

If the value is true, any existing edoc-info file in the
target directory will be ignored and overwritten. The default
value is false.

{packages, boolean()}

If the value is true, it it assumed that packages (module
namespaces) are being used, and that the source code directory
structure reflects this. The default value is true. (Usually,
this does the right thing even if all the modules belong to the
top-level "empty" package.) no_packages is an alias for
{packages, false}. See the subpackages option below for
further details.

If the source code is organized in a hierarchy of
subdirectories although it does not use packages, use
no_packages together with the recursive-search subpackages
option (on by default) to automatically generate documentation
for all the modules.

{source_path, [filename()]}

Specifies a list of file system paths used to locate the source
code for packages.

{source_suffix, string()}

Specifies the expected suffix of input files. The default
value is ".erl".

{subpackages, boolean()}

If the value is true, all subpackages of specified packages
will also be included in the documentation. The default value is
false. no_subpackages is an alias for {subpackages,
false}. See also the exclude_packages option.

Subpackage source files are found by recursively searching
for source code files in subdirectories of the known source code
root directories. (Also see the source_path option.) Directory
names must begin with a lowercase letter and contain only
alphanumeric characters and underscore, or they will be ignored.
(For example, a subdirectory named test-files will not be
searched.)

layout(Doc::edoc_module(), Options::proplist()) -> string()

Specifies a callback module to be used for formatting. The
module must export a function module(Doc, Options). The
default callback module is edoc_layout; see edoc_layout:module/2 for layout-specific options.

read_source(File::filename(), Options::proplist()) -> [syntaxTree()]

If the value is true, the source file will be read via the
Erlang preprocessor (epp). The default value is false.
no_preprocess is an alias for {preprocess, false}.

Normally, preprocessing is not necessary for EDoc to work, but
if a file contains too exotic definitions or uses of macros, it
will not be possible to read it without preprocessing. Note:
comments in included files will not be available to EDoc, even
with this option enabled.

{includes, Path::[string()]}

Specifies a list of directory names to be searched for include
files, if the preprocess option is turned on. Also used with
the @headerfile tag. The default value is the empty list. The
directory of the source file is always automatically appended to
the search path.

{macros, [{atom(), term()}]}

Specifies a list of pre-defined Erlang preprocessor (epp)
macro definitions, used if the preprocess option is turned on.
The default value is the empty list.

{report_missing_types, boolean()}

If the value is true, warnings are issued for missing types.
The default value is false.
no_report_missing_types is an alias for
{report_missing_types, false}.