edoc_lib.3erl man page

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()]

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

edoc

Authors

Richard Carlsson <carlsson.richard@gmail.com>

Info

edoc 0.11 Erlang Module Definition