User's Guide
Reference Manual
Release Notes
PDF
Top

EDoc
Reference Manual
Version 0.7.6.6

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
  - copy_file/2
  - count/2
  - datestr/1
  - escape_uri/1
  - filename/1
  - find_doc_dirs/0
  - find_file/3
  - find_sources/2
  - find_sources/3
  - get_doc_env/1
  - get_doc_env/4
  - get_first_sentence/1
  - is_name/1
  - is_relative_uri/1
  - is_space/1
  - join_uri/2
  - lines/1
  - parse_contact/2
  - parse_expr/2
  - read_info_file/1
  - run_doclet/2
  - run_layout/2
  - segment/2
  - simplify_path/1
  - split_at/2
  - split_at_space/1
  - split_at_stop/1
  - strip_space/1
  - timestr/1
  - to_label/1
  - transpose/1
  - try_subdir/2
  - unique/1
  - uri_get/1
  - write_file/3
  - write_file/4
  - write_info_file/4
- edoc_run
  - Top of manual page
  - application/1
  - file/1
  - files/1
  - packages/1

# edoc_lib

### MODULE

edoc_lib

### MODULE SUMMARY

Utility functions for EDoc.

### DESCRIPTION

Utility functions for EDoc.

### DATA TYPES

edoc_env()

  Environment information needed by EDoc for generating references. The data representation is not documented.

info() = #info{name=string(), mail=string(), uri=string()}

### EXPORTS

copy_file(From, To) -> term()

count(X, Xs) -> term()

datestr(X1) -> term()

escape_uri(Cs) -> term()

filename(T) -> term()

find_doc_dirs() -> term()

find_file(Ps, Pkg, Name) -> term()

find_sources(Path, Opts) -> term()

find_sources(Path, Pkg, Opts) -> term()

See edoc:run/3 for a description of the options subpackages, source_suffix and exclude_packages.

get_doc_env(Options::proplist()) -> edoc_env()

Equivalent to get_doc_env([], [], [], Opts).

get_doc_env(App, Packages, Modules, Options::proplist()) -> edoc_env()

Types:

App = [] | atom()
Packages = [atom()]
Modules = [atom()]
[term()]

Creates an environment data structure used by parts of EDoc for generating references, etc. See edoc:run/3 for a description of the options file_suffix, app_default and doc_path.

See also: edoc:get_doc/3, edoc_extract:source/4.

get_first_sentence(Es) -> term()

is_name(Cs) -> term()

is_relative_uri(Cs) -> term()

is_space(Cs) -> term()

join_uri(Base, Path) -> term()

lines(Cs) -> term()

parse_contact(S, L) -> term()

EDoc "contact information" parsing. This is the type of the content in e.g. @author tags.

parse_expr(S, L) -> term()

EDoc Erlang expression parsing. For parsing things like the content of @equiv tags, and strings denoting file names, e.g. in @headerfile. Also used by edoc_run.

read_info_file(Dir) -> term()

run_doclet(Fun, Opts) -> term()

See edoc:run/3 for a description of the doclet option.

run_layout(Fun, Opts) -> term()

See edoc:layout/2 for a description of the layout option.

segment(Es, N) -> term()

simplify_path(P) -> term()

split_at(Cs, K) -> term()

split_at_space(Cs) -> term()

split_at_stop(Cs) -> term()

strip_space(Cs) -> term()

timestr(X1) -> term()

to_label(Cs) -> term()

transpose(Xss) -> term()

try_subdir(Dir, Subdir) -> term()

unique(Xs) -> term()

uri_get(Path) -> term()

write_file(Text::deep_string(), Dir::filename() (see module edoc), Name::filename() (see module edoc)) -> ok

Write the given Text to the file named by Name in directory Dir. If the target directory does not exist, it will be created.

write_file(Text::deep_string(), Dir::filename() (see module edoc), Name::filename() (see module edoc), Package::atom() | string()) -> ok

Like write_file/3, but adds path components to the target directory corresponding to the specified package.

write_info_file(App, Packages, Modules, Dir) -> term()

### See also

edoc

Richard Carlsson richardc@it.uu.se