User's Guide
Reference Manual
Release Notes
PDF
Top

EDoc
Reference Manual
Version 0.7.7

Expand All
Contract All

Table of Contents

- edoc
  - Top of manual page
  - application/1
  - application/2
  - application/3
  - file/1
  - file/2
  - files/1
  - files/2
  - get_doc/1
  - get_doc/2
  - get_doc/3
  - layout/1
  - layout/2
  - packages/1
  - packages/2
  - read/1
  - read/2
  - read_comments/1
  - read_comments/2
  - read_source/1
  - read_source/2
  - run/4
- edoc_doclet
  - Top of manual page
  - run/2
- edoc_extract
  - Top of manual page
  - file/4
  - header/3
  - header/4
  - header/5
  - source/3
  - source/4
  - source/5
  - text/4
- edoc_layout
  - Top of manual page
  - module/2
  - overview/2
  - package/2
  - type/1
- edoc_lib
  - Top of manual page
  - get_doc_env/4
- edoc_run
  - Top of manual page
  - application/1
  - file/1
  - files/1
  - packages/1

# edoc_run

### MODULE

edoc_run

### MODULE SUMMARY

Interface for calling EDoc from Erlang startup options.

### DESCRIPTION

Interface for calling EDoc from Erlang startup options.

The following is an example of typical usage in a Makefile:

         docs:
                 erl -noshell -run edoc_run application "'$(APP_NAME)'" \
                   '"."' '[{def,{vsn,"$(VSN)"}}]'

(note the single-quotes to avoid shell expansion, and the double-quotes enclosing the strings).

New feature in version 0.6.9: It is no longer necessary to write -s init stop 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.

### EXPORTS

application(Args::[string()]) -> none()

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.

The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system.

file(Args::[string()]) -> none()

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

The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system.

files(Args::[string()]) -> none()

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.

The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system.

packages(Args::[string()]) -> none()

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.

The function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system.

### See also

edoc

Richard Carlsson richardc@it.uu.se