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

NAME

6       edoc_run - Interface for calling EDoc from Erlang startup options.
7

DESCRIPTION

9       Interface for calling EDoc from Erlang startup options.
10
11       The following is an example of typical usage in a Makefile:
12
13            docs:
14                    erl -noshell -run edoc_run application "'$(APP_NAME)'" \
15                      '"."' '[{def,{vsn,"$(VSN)"}}]'
16
17       (note the single-quotes to avoid shell expansion, and the double-quotes
18       enclosing the strings).
19
20       New feature in version 0.6.9: It is no longer  necessary  to  write  -s
21       init  stop last on the command line in order to make the execution ter‐
22       minate. The termination (signalling success or failure to the operating
23       system) is now built into these functions.
24

EXPORTS

26       application(Args::[string()]) -> none()
27
28              Calls  edoc:application/3  with the corresponding arguments. The
29              strings in the list are parsed as  Erlang  constant  terms.  The
30              list can be either [App], [App, Options] or [App, Dir, Options].
31              In the first case edoc:application/1 is called instead;  in  the
32              second case, edoc:application/2 is called.
33
34              The  function call never returns; instead, the emulator is auto‐
35              matically terminated when the  call  has  completed,  signalling
36              success or failure to the operating system.
37
38       file(Args::[string()]) -> none()
39
40              This  function  is deprecated: This is part of the old interface
41              to EDoc and is mainly kept for backwards compatibility. The pre‐
42              ferred  way  of  generating  documentation is through one of the
43              functions application/1 and files/1.
44
45              Calls edoc:file/2 with the corresponding arguments. The  strings
46              in the list are parsed as Erlang constant terms. The list can be
47              either [File] or [File, Options]. In the first  case,  an  empty
48              list of options is passed to edoc:file/2.
49
50              The following is an example of typical usage in a Makefile:
51
52                   $(DOCDIR)/%.html:%.erl
53                           erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \
54                             -s init stop
55
56              The  function call never returns; instead, the emulator is auto‐
57              matically terminated when the  call  has  completed,  signalling
58              success or failure to the operating system.
59
60       files(Args::[string()]) -> none()
61
62              Calls edoc:files/2 with the corresponding arguments. The strings
63              in the list are parsed as Erlang constant terms. The list can be
64              either   [Files]   or  [Files,  Options].  In  the  first  case,
65              edoc:files/1 is called instead.
66
67              The function call never returns; instead, the emulator is  auto‐
68              matically  terminated  when  the  call has completed, signalling
69              success or failure to the operating system.
70

SEE ALSO

72       edoc
73

AUTHORS

75       Richard Carlsson <carlsson.richard@gmail.com>
76
77
78
79                                   edoc 0.10                       edoc_run(3)