From 0ebdf9c62523e516c081ec6eaf6124d5cba76150 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 9 Jan 2016 15:49:51 +0100 Subject: Update user guide --- guide/edoc.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'guide/edoc.html') diff --git a/guide/edoc.html b/guide/edoc.html index e24967c..40ebdde 100644 --- a/guide/edoc.html +++ b/guide/edoc.html @@ -35,11 +35,11 @@ div.navfooter{margin-bottom:1em}
Prev   Next

Chapter 13. EDoc comments

Erlang.mk provides a thin wrapper on top of EDoc, an application that generates documentation based on comments found in modules.

13.1. Writing EDoc comments

The EDoc user guide -explains everything you need to know about EDoc comments.

13.2. Configuration

The EDOC_OPTS variable allows you to specify additional +explains everything you need to know about EDoc comments.

13.2. Configuration

The EDOC_OPTS variable allows you to specify additional EDoc options. Options are documented in the EDoc manual.

A common use for this variable is to enable Markdown in doc comments, using the edown application:

DOC_DEPS = edown
-EDOC_OPTS = {doclet, edown_doclet}

13.3. Usage

To build all documentation, you would typically use:

$ make docs

Do note, however, that EDoc comments will only be generated +EDOC_OPTS = {doclet, edown_doclet}

13.3. Usage

To build all documentation, you would typically use:

$ make docs

Do note, however, that EDoc comments will only be generated automatically if the doc/overview.edoc file exists. If you do not want that file and still want to generate doc comments, two solutions are available.

You can generate EDoc documentation directly:

$ make edoc

You can enable automatic generation on make docs by adding -- cgit v1.2.3