EDoc documentation extraction.
header(File, Env, Opts) -> edoc:entry_data()
header(Forms, File, Env, Opts) -> edoc:entry_data()
Extracts EDoc documentation from commented header file syntax trees. Similar to source/5, but ignores any documentation that occurs before a module declaration or a function definition. (Warning messages are printed if content may be ignored.) Env is assumed to already be set up with a suitable module context.
header(Forms, Comments, File, Env, Opts) -> edoc:entry_data()
source(File, Env, Opts) -> R
source(Forms, File, Env, Opts) -> R
Extracts EDoc documentation from commented source code syntax trees. The given Forms must be a single syntax tree of type form_list, or a list of syntax trees representing "program forms" (cf. edoc:read_source/2. Env is an environment created by edoc_lib:get_doc_env/3. The File argument is used for error reporting and output file name generation only.
See edoc:get_doc/2 for descriptions of the def, hidden, private, and todo options.