[erlang-questions] edoc support for EEP8 type definitions

Richard Carlsson richardc@REDACTED
Mon Mar 31 11:48:58 CEST 2008


Paul Fisher wrote:
> Is there any work planned or underway for supporting documenting the
> EEP8 type definitions more directly, and not requiring the
> re-specification of the type with @type directive?  Basically rather
> than writing the following:
> 
> %% @type foo() = atom().
> %%
> %% A foo is a fundamental type.
> %%
> %% A foo is a really well understood and used programming type that
> %% is fundamental to the programming trade.
> %%
> -type(foo() :: atom()).
> 
> I would love to simply write:
> 
> %% @doc A foo is a fundamental type.
> %%
> %% A foo is a really well understood and used programming type that
> %% is fundamental to the programming trade.
> %%
> -type(foo() :: atom()).
> 

It's planned, yes, but nobody has done any work on it yet.

     /Richard





More information about the erlang-questions mailing list