1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
.TH edoc_run 3 "edoc 0.7.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
edoc_run \- Interface for calling EDoc from Erlang startup options\&.
.SH DESCRIPTION
.LP
Interface for calling EDoc from Erlang startup options\&.
.LP
The following is an example of typical usage in a Makefile:
.nf
docs:
erl -noshell -run edoc_run application "\&'$(APP_NAME)\&'" \en \&'"\&."\&' \&'[{def,{vsn,"$(VSN)"}}]\&'
.fi
.LP
(note the single-quotes to avoid shell expansion, and the double-quotes enclosing the strings)\&.
.LP
\fINew feature in version 0\&.6\&.9\fR: It is no longer necessary to write \fI-s init stop\fR last on the command line in order to make the execution terminate\&. The termination (signalling success or failure to the operating system) is now built into these functions\&.
.SH EXPORTS
.LP
.B
application(Args::[string()]) -> none()
.br
.RS
.LP
Calls edoc:application/3 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[App]\fR, \fI[App, Options]\fR or \fI[App, Dir, Options]\fR\&. In the first case edoc:application/1 is called instead; in the second case, edoc:application/2 is called\&.
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE
.LP
.B
file(Args::[string()]) -> none()
.br
.RS
.LP
\fIThis function is deprecated: \fRThis is part of the old interface to EDoc and is mainly kept for backwards compatibility\&. The preferred way of generating documentation is through one of the functions application/1, packages/1 and files/1\&.
.LP
Calls edoc:file/2 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[File]\fR or \fI[File, Options]\fR\&. In the first case, an empty list of options is passed to edoc:file/2\&.
.LP
The following is an example of typical usage in a Makefile:
.nf
$(DOCDIR)/%\&.html:%\&.erl
erl -noshell -run edoc_run file \&'"$<"\&' \&'[{dir,"$(DOCDIR)"}]\&' \en -s init stop
.fi
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE
.LP
.B
files(Args::[string()]) -> none()
.br
.RS
.LP
Calls edoc:files/2 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[Files]\fR or \fI[Files, Options]\fR\&. In the first case, edoc:files/1 is called instead\&.
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE
.LP
.B
packages(Args::[string()]) -> none()
.br
.RS
.LP
Calls edoc:application/2 with the corresponding arguments\&. The strings in the list are parsed as Erlang constant terms\&. The list can be either \fI[Packages]\fR or \fI[Packages, Options]\fR\&. In the first case edoc:application/1 is called instead\&.
.LP
The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system\&.
.RE
.SH SEE ALSO
.LP
edoc
|
