EDoc

Reference Manual

Version 1.0

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
edoc_layout_chunks
- Top of manual page
- module/2
edoc_lib
edoc_run

edoc_doclet_chunks

Module

edoc_doclet_chunks

Module Summary

Doclet generating standalone EEP-48 doc chunk files.

Description

Doclet generating standalone EEP-48 doc chunk files.

Section Using the EDoc API in the EDoc User's Guide shows an example of using this module.

Exports

run(Doclet_gen::edoc_doclet:command(), Ctxt::edoc_doclet:context()) -> ok

Main doclet entry point.

This doclet is tightly coupled with edoc_layout_chunks and should be used together with it.

The only option this doclet accepts is dir, which controls where the chunks subdirectory and the EEP-48 chunk files will be placed.

See also

edoc_layout_chunks, shell_docs(3)

Radek Szymczyszyn lavrin@gmail.com