Erlang -- EDoc command line interface

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_cmd

### Command

edoc_cmd

### Command Summary

EDoc command line interface EScript.

### Description

This script is a command line entry point to both edoc:application/2 and edoc:files/2 functions. It also allows to generate just the EEP-48 doc chunks (using the -chunks flag) instead of the complete HTML documentation.

### Exports

edoc -app <app> [-chunks]

EDoc is invoked via edoc:application/2, with the default set of options. If -chunks is given, then only doc chunks will be generated, not the full HTML documentation.

Run the script with no arguments to get the full list of options.

edoc -files <erl_file>... [-chunks]

EDoc is invoked via edoc:files/2, with the default set of options. If -chunks is given, then only doc chunks will be generated, not the full HTML documentation.

Run the script with no arguments to get the full list of options.