[erlang-questions] edoc questions

Richard Carlsson <>
Mon Dec 4 16:25:11 CET 2006


Fredrik Thulin wrote:
> Can you please be more specific? At the linked page, I found functions 
> with edoc specifications like this one :
> 
>    %@spec
>    % go_b() -> {ok, Response}
> 
> However, none of them seems to include a textual explanation of Response.

Currently, the way to do this is to put a sentence in the @doc part,
e.g.:

   %% @doc ... `Dst' is the destination for this client transaction. ...

I have been considering adding separate tags for giving individual
parameter descriptions, but alas, I have not had any time to implement
it. Note, btw., that the `...' syntax will expand to <code>...</code>.

     /Richard




More information about the erlang-questions mailing list