edoc_extract

edoc_extract

edoc_extract
EDoc documentation extraction.

EDoc documentation extraction.

Types

File = filename()
Context = context()
Env = edoc:env()
Opts = proplist()
Tags = [term()]
Reason = term()

Reads a text file and returns the list of tags in the file. Any lines of text before the first tag are ignored. Env is an environment created by edoc_lib:get_doc_env/3. Upon error, Reason is an atom returned from the call to file:read_file/1 or the atom 'invalid_unicode'.

See text/4 for options.

Types

File = filename()
Env = edoc:env()
Opts = proplist()

Extracts EDoc documentation from commented header file syntax trees. Similar to source/5, but ignores any documentation that occurs before a module declaration or a function definition. (Warning messages are printed if content may be ignored.) Env is assumed to already be set up with a suitable module context.

See also: erl_recomment(3), header/5.

Types

File = filename()
Env = edoc:env()
Opts = proplist()
R = {module(), edoc:edoc_module()} | {module(), edoc:edoc_module(), [edoc:entry()]}

Extracts EDoc documentation from commented source code syntax trees. The given Forms must be a single syntax tree of type form_list, or a list of syntax trees representing "program forms" (cf. edoc:read_source/2. Env is an environment created by edoc_lib:get_doc_env/3. The File argument is used for error reporting and output file name generation only.

See edoc:get_doc/2 for descriptions of the def, hidden, private, and todo options.

See also: erl_recomment(3), source/5, edoc:read_comments/2, edoc:read_source/2.

Types

Text = string()
Context = context()
Env = edoc:env()
Opts = proplist()
Tags = [term()]

Returns the list of tags in the text. Any lines of text before the first tag are ignored. Env is an environment created by edoc_lib:get_doc_env/3.

See source/4 for a description of the def option.

Richard Carlsson [email protected]