[erlang-questions] I want documentation of Erlang in EDoc format

Kenneth Lundin <>
Wed Sep 5 11:40:02 CEST 2007


Hi,

We, the Erlang/OTP group at Ericsson have used SGML/XML as the source format
for documentation for 5-10 years before Edoc was introduced.

For the XML sources we have DocBuilder (part of the R11B-5
distibution) to build the doc with.

Nowadays we actually use Edoc for some of the documentation and use
a special backend to Edoc which makes it uniform with our other doc.

Edoc is not well suited for all types of documentation and it is also
a matter of
taste if you want to clutter down the source code with very long
descriptive text.

I think Edoc and our DocBuilder will grow together more and more over
time and that you will be able to mix separate documentation files and
documentation embedded in the source code more seamlessly and with a
common markup.

/Kenneth (Erlang/OTP group at Ericsson)

On 9/5/07, Kirill Zaborski <> wrote:
> May I ask what were the reasons of such separation?
> Are there any problems with edoc?
> Doctool supplied with the language and not used by the authors of this
> language - it seems quite suspicious to me :)
>
> Best regards,
> Kirill.
>
> On 9/5/07, Kenneth Lundin <> wrote:
> Hi,
> >
> > You will never get all of the documentation in EDoc format.
> > We are mostly using XML in files separate from the source code for the
> > documentation and we have plans to release those XML sources.
> > The XML format we use is documented in the DocBuilder application
> > which is part of the OTP R11B-5 release.
> >
> > /Kenneth (ERlang/OTP team at Ericsson)
> >
> > On 9/5/07, Mikage Sawatari <> wrote:
> > > Hello,
> > >
> > > How can I get documentation of Erlang in EDoc format? Only HTML
> > > and Man pages are available on the web, but I want EDoc data to
> > > make a tool which can search for functions.
> > >
> > >
> > > Thank, you.
> > >
> > > -----------------------------------------------------------------------
> > > SAWATARI Mikage (SANO Taku)
> > > _______________________________________________
> > > erlang-questions mailing list
> > > 
> > > http://www.erlang.org/mailman/listinfo/erlang-questions
> > >
> > _______________________________________________
> > erlang-questions mailing list
> > 
> > http://www.erlang.org/mailman/listinfo/erlang-questions
> >
>



More information about the erlang-questions mailing list