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() -> term()

count() -> term()

datestr() -> term()

escape_uri() -> term()

filename() -> term()

find_doc_dirs() -> term()

find_file() -> term()

find_sources() -> 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() -> term()

is_name() -> term()

is_relative_uri() -> term()

is_space() -> term()

join_uri() -> term()

lines() -> term()

parse_contact() -> term()

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

parse_expr() -> 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() -> term()

run_doclet() -> term()

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

run_layout() -> term()

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

segment() -> term()

simplify_path() -> term()

split_at() -> term()

split_at_space() -> term()

split_at_stop() -> term()

strip_space() -> term()

timestr() -> term()