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

DATA TYPES

26         args() = [string()]:
27
28

EXPORTS

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

SEE ALSO

76       edoc
77

AUTHORS

79       Richard Carlsson <carlsson.richard@gmail.com>
80
81
82
83                                   edoc 1.2                        edoc_run(3)