Erlang -- edoc_lib

EDoc

Reference Manual

Version 1.0

- User's Guide
- Reference Manual
- Release Notes
- PDF
- Top

- Expand All
- Contract All

### Table of Contents

- edoc
  - Top of manual page
  - application/1
  - application/2
  - application/3
  - file/1
  - file/2
  - files/1
  - files/2
  - get_doc/1
  - get_doc/2
  - get_doc/3
  - layout/1
  - layout/2
  - read/1
  - read/2
  - read_comments/1
  - read_comments/2
  - read_source/1
  - read_source/2
  - run/2
- edoc_cmd
- edoc_doclet
  - Top of manual page
  - run/2
- edoc_doclet_chunks
  - Top of manual page
  - run/2
- edoc_extract
  - Top of manual page
  - file/4
  - header/3
  - header/4
  - header/5
  - source/3
  - source/4
  - source/5
  - text/4
- edoc_layout
  - Top of manual page
  - module/2
  - overview/2
  - type/1
- edoc_layout_chunks
  - Top of manual page
  - module/2
- edoc_lib
  - Top of manual page
  - get_doc_env/3
  - infer_module_app/1
  - write_file/4
- edoc_run
  - Top of manual page
  - application/1
  - file/1
  - files/1

# edoc_lib

### Module

edoc_lib

### Module Summary

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

Richard Carlsson carlsson.richard@gmail.com