[erlang-questions] edoc generation

Raimo Niskanen <>
Wed Jun 19 08:34:00 CEST 2013


On Tue, Jun 18, 2013 at 12:25:52PM +0200, sm wrote:
> Regarding the edoc generation,
> 
> I've looked at the erlang documentation and realized that I need an
> erlang API list of functions to incorporate into a programming
> editor.
> 
> I created a small file with three functions and the calltip work
> just fine with the editor. the full OTP documentation found in
> www.erlang.org has an PDF or HTML as a file format.
> 
> I have two choices:
> 
> 1. Tweak the html file produced by edoc_run,
> 2. or go to the source and just extract the spec and type information.

There might exist a third alternative.

In the documentation tarball, and also online there are index files,
one per application, that is used by e.g the search engine at
http://www.erlang.org/erldoc, and maybe other search engines.

These are created in the normal documentation build and are in
Erlang term format, have a look inside any. To whip up an escript
that outputs any format you like should be dead easy and probably
use file:consult/1.

Here are two:
    http://www.erlang.org/documentation/doc-5.10.1/erts-5.10.1/doc/html/erts.eix
    http://www.erlang.org/documentation/doc-5.10.1/lib/stdlib-1.19.1/doc/html/stdlib.eix

Their format should be fairly stable and is used to map from
application, module and function to html filenames and anchors.
Therefore they contain a documented function list for each module.

> 
> The html produced by edoc_run has less clutter than the OTP
> documentation. I can change the css and change the layout, then copy
> the text from a web browser into an editor for further processing.
> 
> In the past I created an xsl stylesheet for the xml files,
> then transformed the xml file into layout format I needed, but
> inconsistancies showed up.
> 
> sm
> 
> 
> 
> _______________________________________________
> erlang-questions mailing list
> 
> http://erlang.org/mailman/listinfo/erlang-questions

-- 

/ Raimo Niskanen, Erlang/OTP, Ericsson AB


More information about the erlang-questions mailing list