.TH edoc_lib 3erl "edoc 1.2.1" "" "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
proplist() = proplists:proplist():

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

.RS 3
App = atom() | no_app
.br
Modules = [module()]
.br
Options = proplist()
.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
infer_module_app(Mod::module()) -> no_app | {app, atom()}
.br
.RS
.LP
Infer application containing the given module\&.
.LP
It\&'s expected that modules which are not preloaded and don\&'t match the \fI<app>/ebin/<mod>\&.beam\fR\& path pattern will NOT have an app name inferred properly\&. \fIno_app\fR\& is returned in such cases\&.
.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>