From b5d4cb91f80c833795a2d87050c3674bb7aecdc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 3 Oct 2017 13:39:41 +0200 Subject: Update Hugo, docs --- docs/en/erlang.mk/1/guide/edoc/index.html | 110 +++++++++++++++++------------- 1 file changed, 61 insertions(+), 49 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 bc6befd3..6fcaeeed 100644 --- a/docs/en/erlang.mk/1/guide/edoc/index.html +++ b/docs/en/erlang.mk/1/guide/edoc/index.html @@ -7,7 +7,7 @@ - + Nine Nines: EDoc comments @@ -67,60 +67,72 @@

EDoc comments

-

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.

-
-
-
-

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:

-
-
-
-
-
-

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:

-
-
-
-
+

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.

+
+
+
+

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}
+
+
+
+

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
+
+
+ + +