Module edoc_extract

Copyright © 2001-2003 Richard Carlsson

• Description
• Function Index
• Function Details

Authors: Richard Carlsson (richardc@csd.uu.se).

See also: edoc.

Description

Function Index

Function Details

file/4

file(File::filename(), Context, Env::edoc_env(), Options::option_list()) -> {ok, Tags} | {error, Reason}

• Context = overview | package
• Tags = [term()]
• edoc_env() = edoc_lib:edoc_env()
• 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/4. Upon error, Reason is an atom returned from the call to //kernel/file:read_file/1.

See text/4 for options.

source/4

source(Forms, File::filename(), Env::edoc_env(), Options::option_list()) -> {ModuleName, edoc_module()}

• Forms = syntaxTree() | [syntaxTree()]
• ModuleName = atom()
• edoc_module() = edoc:edoc_module()
• edoc_env() = edoc_lib:edoc_env()

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/4. 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, and private options.

See also: erl_recomment, source/5.

source/5

source(Forms, Comments::[comment()], File::filename(), Env::edoc_env(), Options::option_list()) -> {ModuleName, edoc_module()}

• Forms = syntaxTree() | [syntaxTree()]
• comment() = {Line, Column, Indentation, Text}
• Line = integer()
• Column = integer()
• Indentation = integer()
• Text = [string()]
• ModuleName = atom()

Like source/4, but first inserts the given comments in the syntax trees. The syntax trees must contain valid position information. (Cf. edoc:read_comments/2.)

See also: //syntax_tools/erl_recomment, source/4, edoc:read_comments/2, edoc:read_source/2.

text/4

text(Text::string(), Context, Env::edoc_env(), Options::option_list()) -> Tags

• Context = overview | package
• Tags = [term()]
• edoc_env() = edoc_lib:edoc_env()

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/4.

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