.TH edoc_lib 3erl "edoc 0.12" "" "Erlang Module Definition"
.SH NAME
edoc_lib \- Utility functions for EDoc.
.SH DESCRIPTION
.LP
Utility functions for EDoc\&.
.SH "DATA TYPES"

.RS 2
.TP 2
.B
edoc_env():

.RS 2
.LP
Environment information needed by EDoc for generating references\&. The data representation is not documented\&.
.RE

.TP 2
.B
proplist() = proplists:property():

.RE
.SH EXPORTS
.LP
.B
get_doc_env(App, Modules, Options::proplist()) -> edoc_env()
.br
.RS
.LP
Types:

.RS 3
App = [] | atom()
.br
Modules = [atom()]
.br
proplist() = [term()]
.br
.RE
.RE
.RS
.LP
Creates an environment data structure used by parts of EDoc for generating references, etc\&. See edoc:run/2 for a description of the options \fIfile_suffix\fR\&, \fIapp_default\fR\& and \fIdoc_path\fR\&\&.
.LP
\fISee also:\fR\& edoc:get_doc/3, edoc_extract:source/4\&.
.RE

.LP
.B
write_file(Text, Dir, Name, Options) -> term() 
.br
.RS
.RE

.SH "SEE ALSO"

.LP
edoc
.SH AUTHORS
.LP
Richard Carlsson
.I
<carlsson\&.richard@gmail\&.com>