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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module edoc_run</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css">
</head>
<body bgcolor="white">
<h1>Module edoc_run</h1>
Interface for calling EDoc from Erlang startup options.
<p>Copyright 2003 Richard Carlsson</p>
<ul><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<p><b>Authors:</b> Richard Carlsson (<a href="mailto:richardc@csd.uu.se"><tt>richardc@csd.uu.se</tt></a>).</p>
<p><b>See also:</b> <a href="edoc.html">edoc</a>.</p>
<h2><a name="description">Description</a></h2><p>Interface for calling EDoc from Erlang startup options.</p>
The following is an example of typical usage in a Makefile:
<pre> docs:
erl -noshell -run edoc_run application "'$(APP_NAME)'" \
'"."' '[{def,{vsn,"$(VSN)"}}]'</pre><p>
(note the single-quotes to avoid shell expansion, and the
double-quotes enclosing the strings).</p>
<strong>New feature in version 0.6.9</strong>: It is no longer
necessary to write <code>-s init stop</code> 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.
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1"><tr><td valign="top"><a href="#application-1">application/1</a></td><td>Calls <a href="edoc.html#application-3"><code>edoc:application/3</code></a> with the corresponding
arguments.</td></tr>
<tr><td valign="top"><a href="#file-1">file/1</a></td><td>Calls <a href="edoc.html#file-2"><code>edoc:file/2</code></a> with the corresponding arguments.</td></tr>
<tr><td valign="top"><a href="#files-1">files/1</a></td><td>Calls <a href="edoc.html#files-2"><code>edoc:files/2</code></a> with the corresponding arguments.</td></tr>
<tr><td valign="top"><a href="#packages-1">packages/1</a></td><td>Calls <a href="edoc.html#application-2"><code>edoc:application/2</code></a> with the corresponding
arguments.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3><a name="application-1">application/1</a></h3>
<p><tt>application(Args::[string()]) -> none()</tt></p>
<p><p>Calls <a href="edoc.html#application-3"><code>edoc:application/3</code></a> with the corresponding
arguments. The strings in the list are parsed as Erlang constant
terms. The list can be either <code>[App]</code>, <code>[App, Options]</code> or <code>[App,
Dir, Options]</code>. In the first case <a href="edoc.html#application-1"><code>edoc:application/1</code></a> is
called instead; in the second case, <a href="edoc.html#application-2"><code>edoc:application/2</code></a> is
called.</p>
The function call never returns; instead, the emulator is
automatically terminated when the call has completed, signalling
success or failure to the operating system.</p>
<h3><a name="file-1">file/1</a></h3>
<p><tt>file(Args::[string()]) -> none()</tt></p>
<p><b>This function is deprecated:</b> This 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 <a href="#application-1"><code>application/1</code></a>,
<a href="#packages-1"><code>packages/1</code></a> and <a href="#files-1"><code>files/1</code></a>.
</p>
<p><p>Calls <a href="edoc.html#file-2"><code>edoc:file/2</code></a> with the corresponding arguments. The
strings in the list are parsed as Erlang constant terms. The list can
be either <code>[File]</code> or <code>[File, Options]</code>. In the first case, an empty
list of options is passed to <a href="edoc.html#file-2"><code>edoc:file/2</code></a>.</p>
The following is an example of typical usage in a Makefile:
<pre> $(DOCDIR)/%.html:%.erl
erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \
-s init stop</pre>
The function call never returns; instead, the emulator is
automatically terminated when the call has completed, signalling
success or failure to the operating system.</p>
<h3><a name="files-1">files/1</a></h3>
<p><tt>files(Args::[string()]) -> none()</tt></p>
<p><p>Calls <a href="edoc.html#files-2"><code>edoc:files/2</code></a> with the corresponding arguments. The
strings in the list are parsed as Erlang constant terms. The list can
be either <code>[Files]</code> or <code>[Files, Options]</code>. In the first case, <a href="edoc.html#files-1"><code>edoc:files/1</code></a> is called instead.</p>
The function call never returns; instead, the emulator is
automatically terminated when the call has completed, signalling
success or failure to the operating system.</p>
<h3><a name="packages-1">packages/1</a></h3>
<p><tt>packages(Args::[string()]) -> none()</tt></p>
<p><p>Calls <a href="edoc.html#application-2"><code>edoc:application/2</code></a> with the corresponding
arguments. The strings in the list are parsed as Erlang constant
terms. The list can be either <code>[Packages]</code> or <code>[Packages, Options]</code>.
In the first case <a href="edoc.html#application-1"><code>edoc:application/1</code></a> is called instead.</p>
The function call never returns; instead, the emulator is
automatically terminated when the call has completed, signalling
success or failure to the operating system.</p>
</body>
</html>
|
