Erlang Central

Difference between revisions of "EDoc Generation"

From ErlangCentral Wiki

(20 intermediate revisions by one user not shown)
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@yourcompany.com >
 
%% @copyright © 2010 Your Company
 
%% @copyright © 2010 Your Company
 
%% @version 1.0.0
 
%% @version 1.0.0
Line 16:Line 16:
 
%% display as "YYYY-MM-DD".
 
%% display as "YYYY-MM-DD".
 
</code>
 
</code>
 +
 +
 +
 +
==Generating Documentation from EDoc Tags==
 +
The following functions are used to extract the documentation from EDoc tags:
 +
 +
* ''edoc:application/2'' : Creates documentation for a typical Erlang application.
 +
* ''edoc:packages/2'' : Creates documentation for one or more packages, automatically locating source files.
 +
* ''edoc:files/2'' : ('''Deprecated''') Creates documentation for a specified set of source files.
 +
* ''edoc:run/3'' : General interface function; the common back-end for the above functions.
 +
 +
 +
 +
{Examples needed to illustrate how the functions to extract EDoc documentation are used, and the syntax required.}
  
  

Revision as of 15:03, 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 < unknown.author@yourcompany.com >
%% @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".


Generating Documentation from EDoc Tags

The following functions are used to extract the documentation from EDoc tags:

  • edoc:application/2 : Creates documentation for a typical Erlang application.
  • edoc:packages/2 : Creates documentation for one or more packages, automatically locating source files.
  • edoc:files/2 : (Deprecated) Creates documentation for a specified set of source files.
  • edoc:run/3 : General interface function; the common back-end for the above functions.


{Examples needed to illustrate how the functions to extract EDoc documentation are used, and the syntax required.}



Additional Documentation

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