| edoc_lib(3erl) | Erlang Module Definition | edoc_lib(3erl) |
edoc_lib - Utility functions for EDoc.
Utility functions for EDoc.
Environment information needed by EDoc for generating references. The data representation is not documented.
get_doc_env(App, Modules, Options::proplist()) ->
edoc_env()
Types:
Creates an environment data structure used by parts of EDoc for generating references, etc. See edoc:run/2 for a description of the options file_suffix, app_default and doc_path.
See also: edoc:get_doc/3, edoc_extract:source/4.
write_file(Text, Dir, Name, Options) -> term()
edoc
Richard Carlsson <carlsson.richard@gmail.com>
| edoc 0.12 |