[erlang-questions] Edoc question

Robert Virding <>
Mon Sep 22 18:53:40 CEST 2008

I have a small question about using edoc.

The "standard" way for an application seems to be to have an overview file
and then generate files for every module taking the documentation from the
source files. Also the formatting available in the overview is quite
primitive, at least compared to that available for the source files. Have I
understood the basics correctly here?

The problem is that I don't want to work that way. What I need/would like

- For my applications I would like to write an extended description of the
system in the overview and need the full formatting in the overview. Edoc
itself does this by having a user's guide, this would be acceptable, while
yecc puts everything into description of the yecc module, which I think is
the wrong place for it.

- I do not like to put user documentation in source files, it clutters them
up unnecessarily. In my view source files should only contain documentation
which is relevant for understanding the code, having user documentation in
the same file I think clutters it up unnecessarily, and hides what is
essential for the code.

Now the answer to these questions may very well be RTFM then please just
tell me where in the FM to R.

While I am at it: can you get something which suitable for paper and not
just HTML? Printing out from the browser is not good enough.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20080922/06c525d6/attachment.html>

More information about the erlang-questions mailing list