table of contents
other versions
- buster 1:21.2.6+dfsg-1
- testing 1:23.2.6+dfsg-1
- unstable 1:23.2.6+dfsg-1
- experimental 1:24.0.5+dfsg-1
edoc_lib(3erl) | Erlang Module Definition | edoc_lib(3erl) |
NAME¶
edoc_lib - Utility functions for EDoc.DESCRIPTION¶
Utility functions for EDoc.DATA TYPES¶
- edoc_env():
Environment information needed by EDoc for generating references. The data representation is not documented.
- proplist() = proplists:property():
EXPORTS¶
get_doc_env(App, Modules, Options::proplist()) -> edoc_env()Types:
App = [] | atom()
Modules = [atom()]
proplist() = [term()]
Modules = [atom()]
proplist() = [term()]
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()
SEE ALSO¶
edocAUTHORS¶
Richard Carlsson <carlsson.richard@gmail.com>edoc 0.9.4 |