[erlang-questions] idea: function meta data

Richard Carlsson <>
Fri Nov 16 12:13:59 CET 2007


Christian S wrote:
> Perhaps one can
> establish a norm to make the first sentence of edoc a good summary
> that should be useful on its own.

Well, that is precisely how edoc does right now, to get the
short summary for use in the function index etc. What is missing
is some way of making the description accessible at runtime.

One way would be for edoc to insert documentation into a global
dets table (similar to the persistent table used by dialyzer).
Another would be to compile it into the module itself, but that
would increase the compile times quite a lot.

     /Richard




More information about the erlang-questions mailing list