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         proplist() = proplists:proplist():
13
14

EXPORTS

16       get_doc_env(App, Modules, Options) -> edoc:env()
17
18              Types:
19
20                 App = atom() | no_app
21                 Modules = [module()]
22                 Options = proplist()
23
24              Creates  an environment data structure used by parts of EDoc for
25              generating references, etc. See edoc:run/2 for a description  of
26              the options file_suffix, app_default and doc_path.
27
28              See also: edoc:get_doc/3, edoc_extract:source/4.
29
30       infer_module_app(Mod::module()) -> no_app | {app, atom()}
31
32              Infer application containing the given module.
33
34              It's  expected  that  modules  which are not preloaded and don't
35              match the <app>/ebin/<mod>.beam path pattern will  NOT  have  an
36              app name inferred properly. no_app is returned in such cases.
37
38       write_file(Text, Dir, Name, Options) -> term()
39

SEE ALSO

41       edoc
42

AUTHORS

44       Richard Carlsson <carlsson.richard@gmail.com>
45
46
47
48                                   edoc 1.1                        edoc_lib(3)