[erlang-questions] edoc: documenting "-type"
Wed Jul 13 11:30:43 CEST 2011
It is not supported via the traditional edoc syntax, however it is supported
by the new type documentation generation. If you write
-type key() :: binary() | atom().
%% This type is awesome. Really, it is great.
The comment below the type will be included in the generated edoc.
On Wed, Jul 13, 2011 at 8:49 AM, Richard Carlsson <
> On 2011-07-12 23:25, Daniel Goertzen wrote:
>> I am trying to document a "-type" close to the top of my modules like
>> %% @doc This type is awesome. Really, it is great.
>> -type key() :: binary() | atom().
>> ... but it collides with my module @doc entry above it ("multiple @doc
>> tag" error).
>> Is there a right way to document types or is this not supported right
>> now? The generated documentation shows all my types nicely, but I'd
>> love to have a bit of explanation appear with them.
> It's not supported right now, but it's a good idea. Thanks.
> erlang-questions mailing list
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the erlang-questions