1edoc_lib(3)                Erlang Module Definition                edoc_lib(3)
2
3
4

NAME

6       edoc_lib - Utility functions for EDoc.
7

DESCRIPTION

9       Utility functions for EDoc.
10

DATA TYPES

12         edoc_env():
13
14
15           Environment  information  needed by EDoc for generating references.
16           The data representation is not documented.
17
18         proplist() = proplists:property():
19
20

EXPORTS

22       get_doc_env(App, Modules, Options::proplist()) -> edoc_env()
23
24              Types:
25
26                 App = [] | atom()
27                 Modules = [atom()]
28                 proplist() = [term()]
29
30              Creates an environment data structure used by parts of EDoc  for
31              generating  references, etc. See edoc:run/2 for a description of
32              the options file_suffix, app_default and doc_path.
33
34              See also: edoc:get_doc/3, edoc_extract:source/4.
35
36       write_file(Text, Dir, Name, Options) -> term()
37

SEE ALSO

39       edoc
40

AUTHORS

42       Richard Carlsson <carlsson.richard@gmail.com>
43
44
45
46                                   edoc 0.11                       edoc_lib(3)