Erlang -- edoc_lib

User's Guide
Reference Manual
Release Notes
PDF
Top

EDoc
Reference Manual
Version 0.8.1

Expand All
Contract All

Table of Contents

- edoc
  - Top of manual page
  - application/1
  - application/3
  - application/2
  - file/1
  - file/2
  - files/1
  - files/2
  - get_doc/1
  - get_doc/3
  - get_doc/2
  - layout/1
  - layout/2
  - read/1
  - read/2
  - read_comments/1
  - read_comments/2
  - read_source/2
  - read_source/1
  - run/2
- edoc_doclet
  - Top of manual page
  - run/2
- edoc_extract
  - Top of manual page
  - file/4
  - header/3
  - header/5
  - header/4
  - source/3
  - source/5
  - source/4
  - text/4
- edoc_layout
  - Top of manual page
  - module/2
  - overview/2
  - type/1
- edoc_lib
  - Top of manual page
  - get_doc_env/3
  - 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

edoc_env()

  Environment information needed by EDoc for generating references. The data representation is not documented.

proplist() = proplists:property()

### EXPORTS

get_doc_env(App, Modules, Options::proplist()) -> edoc_env()

Types:

App = [] | atom()
Modules = [atom()]
proplist() = [term()]

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.

write_file(Text, Dir, Name, Options) -> term()

### See also

edoc

Richard Carlsson carlsson.richard@gmail.com