edoc_extract(3erl) Erlang Module Definition edoc_extract(3erl)
NAME
edoc_extract - EDoc documentation extraction.
DESCRIPTION
EDoc documentation extraction.
DATA TYPES
edoc_env() = edoc_lib:edoc_env():
filename() = file:filename():
proplist() = proplists:property():
syntaxTree() = erl_syntax:syntaxTree():
EXPORTS
file(File::filename(), Context, Env::edoc_env(), Options::proplist())
-> {ok, Tags} | {error, Reason}
Types:
Context = overview
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 envi-
ronment 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.
header(File::filename(), Env::edoc_env(), Options::proplist()) -> {ok,
Tags} | {error, Reason}
Types:
Tags = [term()]
Reason = term()
Similar to header/5, but reads the syntax tree and the comments
from the specified file.
See also: header/4, edoc:read_comments/2, edoc:read_source/2.
header(Forms, File::filename(), Env::edoc_env(), Options::proplist())
-> {ok, Tags} | {error, Reason}
Types:
Forms = syntaxTree() | [syntaxTree()]
Tags = [term()]
Reason = term()
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(3erl), header/5.
header(Forms, Comments::[edoc:comment()], File::filename(),
Env::edoc_env(), Options::proplist()) -> {ok, Tags} | {error, Reason}
Types:
Forms = syntaxTree() | [syntaxTree()]
Tags = [term()]
Reason = term()
Similar to header/4, but first inserts the given comments in the
syntax trees. The syntax trees must contain valid position in-
formation. (Cf. edoc:read_comments/2.)
See also: erl_recomment(3erl), header/3, header/4.
source(File::filename(), Env::edoc_env(), Options::proplist()) -> {Mod-
uleName, edoc:edoc_module()}
Types:
ModuleName = atom()
proplist() = [term()]
Like source/5, but reads the syntax tree and the comments from
the specified file.
See also: source/4, edoc:read_comments/2, edoc:read_source/2.
source(Forms, File::filename(), Env::edoc_env(), Options::proplist())
-> {ModuleName, edoc:edoc_module()}
Types:
Forms = syntaxTree() | [syntaxTree()]
ModuleName = atom()
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 re-
porting 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(3erl), source/5, edoc:read_comments/2,
edoc:read_source/2.
source(Forms, Comments::[edoc:comment()], File::filename(),
Env::edoc_env(), Options::proplist()) -> {ModuleName, edoc:edoc_mod-
ule()}
Types:
Forms = syntaxTree() | [syntaxTree()]
ModuleName = atom()
Like source/4, but first inserts the given comments in the syn-
tax trees. The syntax trees must contain valid position informa-
tion. (Cf. edoc:read_comments/2.)
See also: erl_recomment(3erl), source/3, source/4,
edoc:read_comments/2, edoc:read_source/2.
text(Text::string(), Context, Env::edoc_env(), Options::proplist()) ->
Tags
Types:
Context = overview
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.
SEE ALSO
edoc
AUTHORS
Richard Carlsson <carlsson.richard@gmail.com>
edoc 0.12 edoc_extract(3erl)