From fe3492a98de29942477b061cd02c92246f4bf85a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 28 Mar 2016 15:36:42 +0200 Subject: Initial commit, new website system --- docs/en/erlang.mk/1/guide/edoc/index.html | 193 ++++++++++++++++++++++++++++++ 1 file changed, 193 insertions(+) create mode 100644 docs/en/erlang.mk/1/guide/edoc/index.html (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 new file mode 100644 index 00000000..97ab6018 --- /dev/null +++ b/docs/en/erlang.mk/1/guide/edoc/index.html @@ -0,0 +1,193 @@ + + + + + + + + + + + + Nine Nines: EDoc comments + + + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

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:

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

+ Erlang.mk + 1 + + User Guide +

+ +
    + + + +
+ +

Navigation

+ +

Version select

+
    + + + +
  • 1
    • + +
+ +
+
+
+
+ + + + + + + + + + + + -- cgit v1.2.3