---
name: "edoc_doclet"
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_doclet"
---

# edoc\_doclet(3erl)

Standard doclet module for EDoc.

## NAME

edoc\_doclet - Standard doclet module for EDoc.

## DESCRIPTION

Standard doclet module for EDoc.

## DATA TYPES

- **command() = doclet\_gen() \| doclet\_toc():**

  Doclet commands.

- **context() = #doclet\_context{dir=string(), env=edoc:env(), opts=\[term()\]}:**

  Context for doclets.

- **doclet\_gen() = #doclet\_gen{sources=\[string()\], app=no\_app \| atom(), modules=\[module()\]}:**

  Doclet command.

- **doclet\_toc() = #doclet\_toc{paths=\[string()\], indir=string()}:**

  Doclet command.

## EXPORTS

**run(Doclet\_gen::edoc\_doclet:command(), Ctxt::edoc\_doclet: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

## AUTHORS

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