diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/edoc/index.html')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/edoc/index.html | 64 |
1 files changed, 22 insertions, 42 deletions
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 @@ <h1 class="lined-header"><span>EDoc comments</span></h1> -<div class="paragraph"><p>Erlang.mk provides a thin wrapper on top of EDoc, an application -that generates documentation based on comments found in modules.</p></div> -<div class="sect1"> +<p>Erlang.mk provides a thin wrapper on top of EDoc, an application that generates documentation based on comments found in modules.</p> <h2 id="_writing_edoc_comments">Writing EDoc comments</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <a href="http://www.erlang.org/doc/apps/edoc/chapter.html">EDoc user guide</a> -explains everything you need to know about EDoc comments.</p></div> -</div> -</div> -<div class="sect1"> +<p>The <a href="http://www.erlang.org/doc/apps/edoc/chapter.html">EDoc user guide</a> explains everything you need to know about EDoc comments.</p> <h2 id="_configuration">Configuration</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The <code>EDOC_OPTS</code> variable allows you to specify additional -EDoc options. Options are documented in the -<a href="http://www.erlang.org/doc/man/edoc.html#run-2">EDoc manual</a>.</p></div> -<div class="paragraph"><p>A common use for this variable is to enable Markdown in doc -comments, using the <code>edown</code> application:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>The <code>EDOC_OPTS</code> variable allows you to specify additional EDoc options. Options are documented in the <a href="http://www.erlang.org/doc/man/edoc.html#run-2">EDoc manual</a>.</p> +<p>A common use for this variable is to enable Markdown in doc comments, using the <code>edown</code> application:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="color: #009900">DOC_DEPS =</span> edown -<span style="color: #009900">EDOC_OPTS =</span> {doclet<span style="color: #990000">,</span> edown_doclet}</tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">DOC_DEPS =</font> edown +<font color="#009900">EDOC_OPTS =</font> {doclet<font color="#990000">,</font> edown_doclet}</tt></pre> +</div></div> <h2 id="_usage">Usage</h2> -<div class="sectionbody"> -<div class="paragraph"><p>To build all documentation, you would typically use:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>To build all documentation, you would typically use:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make docs</tt></pre></div></div> -<div class="paragraph"><p>Do note, however, that EDoc comments will only be generated -automatically if the <em>doc/overview.edoc</em> file exists. If you -do not want that file and still want to generate doc comments, -two solutions are available.</p></div> -<div class="paragraph"><p>You can generate EDoc documentation directly:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make docs</tt></pre> +</div></div> +<p>Do note, however, that EDoc comments will only be generated automatically if the <em>doc/overview.edoc</em> 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> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make edoc</tt></pre></div></div> -<div class="paragraph"><p>You can enable automatic generation on <code>make docs</code> by adding -the following to your Makefile:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make edoc</tt></pre> +</div></div> +<p>You can enable automatic generation on <code>make docs</code> by adding the following to your Makefile:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="color: #990000">docs::</span> edoc</tt></pre></div></div> -</div> -</div> +<pre><tt><font color="#990000">docs::</font> edoc</tt></pre> +</div></div> + |