---
name: "edoc_lib"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/edoc_lib"
---

# edoc\_lib(3erl)

Utility functions for EDoc.

## NAME

edoc\_lib - Utility functions for EDoc.

## DESCRIPTION

Utility functions for EDoc.

## DATA TYPES

- **proplist() = proplists:proplist():**

  ## EXPORTS

**get\_doc\_env(App, Modules, Options) -\> edoc:env()**\

Types:

App = atom() \| no\_app\
 Modules = \[module()\]\
 Options = proplist()\

Creates an environment data structure used by parts of EDoc for generating references, etc. See edoc:run/2 for a description of the options *file\_suffix*, *app\_default* and *doc\_path*.

*See also:* edoc:get\_doc/3, edoc\_extract:source/4.

**infer\_module\_app(Mod::module()) -\> no\_app \| {app, atom()}**\

Infer application containing the given module.

It's expected that modules which are not preloaded and don't match the *\<app\>/ebin/\<mod\>.beam* path pattern will NOT have an app name inferred properly. *no\_app* is returned in such cases.

**write\_file(Text, Dir, Name, Options) -\> term()** \

## SEE ALSO

edoc

## AUTHORS

Richard Carlsson *\<carlsson.richard@gmail.com\>*