Copyright © 2003 Richard Carlsson
Authors: Richard Carlsson (richardc@csd.uu.se).
See also: edoc.
docs: erl -noshell -run edoc_run application "'$(APP_NAME)'" \ '"."' '[{def,{vsn,"$(VSN)"}}]' -s init stop(note the single-quotes to avoid shell expansion, and the double-quotes enclosing the strings).
application/1 | Calls edoc:application/3 with the corresponding
arguments. |
file/1 | Calls edoc:file/2 with the corresponding arguments. |
files/1 | Calls edoc:files/2 with the corresponding arguments. |
packages/1 | Calls edoc:application/2 with the corresponding
arguments. |
application(Args::[string()]) -> ok | error
Calls edoc:application/3
with the corresponding
arguments. The strings in the list are parsed as Erlang constant
terms. The list can be either [App]
, [App, Options]
or [App,
Dir, Options]
. In the first case edoc:application/1
is
called instead; in the second case, edoc:application/2
is
called.
file(Args::[string()]) -> ok | error
This function is deprecated: 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 application/1
,
packages/1
and files/1
.
Calls edoc:file/2
with the corresponding arguments. The
strings in the list are parsed as Erlang constant terms. The list can
be either [File]
or [File, Options]
. In the first case, an empty
list of options is passed to edoc:file/2
.
The following is an example of typical usage in a Makefile:
$(DOCDIR)/%.html:%.erl erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \ -s init stop
files(Args::[string()]) -> ok | error
Calls edoc:files/2
with the corresponding arguments. The
strings in the list are parsed as Erlang constant terms. The list can
be either [Files]
or [Files, Options]
. In the first case, edoc:files/1
is called instead.
packages(Args::[string()]) -> ok | error
Calls edoc:application/2
with the corresponding
arguments. The strings in the list are parsed as Erlang constant
terms. The list can be either [Packages]
or [Packages, Options]
.
In the first case edoc:application/1
is called instead.