aboutsummaryrefslogtreecommitdiffstats
path: root/guide/edoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'guide/edoc.html')
-rw-r--r--guide/edoc.html12
1 files changed, 11 insertions, 1 deletions
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}
</header>
<main>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="asciidoc.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="tests.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="edoc"></a>Chapter 13. EDoc comments</h2></div></div></div><p>Placeholder chapter.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="asciidoc.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="docs.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="tests.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="asciidoc.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="tests.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="edoc"></a>Chapter 13. EDoc comments</h2></div></div></div><p>Erlang.mk provides a thin wrapper on top of EDoc, an application
+that generates documentation based on comments found in modules.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_edoc_comments"></a>13.1. Writing EDoc comments</h2></div></div></div><p>The <a class="ulink" href="http://www.erlang.org/doc/apps/edoc/chapter.html" target="_top">EDoc user guide</a>
+explains everything you need to know about EDoc comments.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_2"></a>13.2. Configuration</h2></div></div></div><p>The <code class="literal">EDOC_OPTS</code> variable allows you to specify additional
+EDoc options. Options are documented in the
+<a class="ulink" href="http://www.erlang.org/doc/man/edoc.html#run-2" target="_top">EDoc manual</a>.</p><p>A common use for this variable is to enable Markdown in doc
+comments, using the <code class="literal">edown</code> application:</p><pre class="programlisting">DOC_DEPS = edown
+EDOC_OPTS = {doclet, edown_doclet}</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage"></a>13.3. Usage</h2></div></div></div><p>To build all documentation, you would typically use:</p><pre class="programlisting">$ make docs</pre><p>Do note, however, that EDoc comments will only be generated
+automatically if the <span class="emphasis"><em>doc/overview.edoc</em></span> file exists. If you
+do not want that file and still want to generate doc comments,
+two solutions are available.</p><p>You can generate EDoc documentation directly:</p><pre class="programlisting">$ make edoc</pre><p>You can enable automatic generation on <code class="literal">make docs</code> by adding
+the following to your Makefile:</p><pre class="programlisting">docs:: edoc</pre></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="asciidoc.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="docs.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="tests.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
</main>
</body>
</html>