User's Guide
Reference Manual
Release Notes
PDF
Top

EDoc
Reference Manual
Version 0.7.9.1

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
  - packages/1
  - packages/2
  - read/1
  - read/2
  - read_comments/1
  - read_comments/2
  - read_source/1
  - read_source/2
  - run/3
- edoc_doclet
  - 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
  - package/2
  - type/1
- edoc_lib
  - Top of manual page
  - get_doc_env/4
- edoc_run
  - Top of manual page
  - application/1
  - file/1
  - files/1
  - packages/1

# edoc_doclet

### MODULE

edoc_doclet

### MODULE SUMMARY

Standard doclet module for EDoc.

### DESCRIPTION

Standard doclet module for EDoc.

### DATA TYPES

doclet_gen() = #doclet_gen{sources=[string()], app=no_app() | atom(), packages=[atom()], modules=[atom()], modules=[atom()], filemap=function()}
doclet_toc() = #doclet_gen{paths=[string()], indir=string()}
edoc_context() = #context{dir=string(), env=edoc_env() (see module edoc_lib), opts=[term()]}
no_app()

  A value used to mark absence of an Erlang application context. Use the macro NO_APP defined in edoc_doclet.hrl to produce this value.

### EXPORTS

run(Command::doclet_gen() | doclet_toc(), Ctxt::edoc_context()) -> ok

Main doclet entry point. See the file edoc_doclet.hrl for the data structures used for passing parameters.

Also see edoc:layout/2 for layout-related options, and edoc:get_doc/2 for options related to reading source files.

Options:

{file_suffix, string()}

  Specifies the suffix used for output files. The default value is ".html".

{hidden, boolean()}

  If the value is true, documentation of hidden modules and functions will also be included. The default value is false.

{overview, edoc:filename()}

  Specifies the name of the overview-file. By default, this doclet looks for a file "overview.edoc" in the target directory.

{private, boolean()}

  If the value is true, documentation of private modules and functions will also be included. The default value is false.

{stylesheet, string()}

  Specifies the URI used for referencing the stylesheet. The default value is "stylesheet.css". If an empty string is specified, no stylesheet reference will be generated.

{stylesheet_file, edoc:filename()}

  Specifies the name of the stylesheet file. By default, this doclet uses the file "stylesheet.css" in the priv subdirectory of the EDoc installation directory. The named file will be copied to the target directory.

{title, string()}

  Specifies the title of the overview-page.

### See also

edoc

Richard Carlsson carlsson.richard@gmail.com