From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- docs/en/erlang.mk/1/guide/edoc/index.html | 64 +++++++++++-------------------- 1 file changed, 22 insertions(+), 42 deletions(-) (limited to 'docs/en/erlang.mk/1/guide/edoc/index.html') diff --git a/docs/en/erlang.mk/1/guide/edoc/index.html b/docs/en/erlang.mk/1/guide/edoc/index.html index cb234d92..06f620ad 100644 --- a/docs/en/erlang.mk/1/guide/edoc/index.html +++ b/docs/en/erlang.mk/1/guide/edoc/index.html @@ -62,63 +62,43 @@

EDoc comments

-

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

-
+

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

Writing EDoc comments

-
-

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

-
-
-
+

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

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}
-
-
-
+
DOC_DEPS = edown
+EDOC_OPTS = {doclet, edown_doclet}
+

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
-
- +
docs:: edoc
+ + -- cgit v1.2.3