From 3459fae23a1b652992da540374e82058d69aab04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 9 Jan 2016 13:38:06 +0100 Subject: Update user guide --- guide/edoc.html | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'guide/edoc.html') diff --git a/guide/edoc.html b/guide/edoc.html index 9d68a75..e24967c 100644 --- a/guide/edoc.html +++ b/guide/edoc.html @@ -33,7 +33,17 @@ div.navfooter{margin-bottom:1em}
-
Prev   Next

Chapter 13. EDoc comments

Placeholder chapter.

Prev Up Next
 Home 
+
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 +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 +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 +the following to your Makefile:

docs:: edoc
Prev Up Next
 Home 
-- cgit v1.2.3