EDoc Generation

From Erlang Community

(Difference between revisions)
Revision as of 14:31, 11 June 2010 (edit)
Ray.feliciano@db.com (Talk | contribs)

← Previous diff		 Revision as of 14:33, 11 June 2010 (edit) (undo)
Ray.feliciano@db.com (Talk | contribs)

Next diff →
Line 4: Line 4:
==Sample EDoc Tags== ==Sample EDoc Tags==
-The following illustrates some of the tags that may be embedded within comments to be used by EDoc to generate documentation.+The following illustrates some of the tags that may be embedded within comments to be used by EDoc to generate documentation. Tags are preceded by the '@' symbol.
<code> <code>
-%% @author Unknown Author <unknown.author@db.com>+%% @author Unknown Author \<unknown.author@db.com>
%% @copyright © 2010 Your Company %% @copyright © 2010 Your Company
%% @version 1.0.0 %% @version 1.0.0

Revision as of 14:33, 11 June 2010

EDoc is the Erlang documentation generator that extracts useful information regarding modules and functions from specially tagged comments included in the code.


Sample EDoc Tags

The following illustrates some of the tags that may be embedded within comments to be used by EDoc to generate documentation. Tags are preceded by the '@' symbol. 


%% @author Unknown Author \
%% @copyright © 2010 Your Company
%% @version 1.0.0
%% @title The `displayDate' function.
%% @doc `displayDate' takes a date/time as a parameter, and reformats it to
%% display as "YYYY-MM-DD".



Additional Documentation

http://www.erlang.org/documentation/doc-5.7/pdf/edoc-0.7.6.3.pdf

Retrieved from "http://www.trapexit.org/EDoc_Generation"
Erlang/OTP Projects
Personal tools