[erlang-questions] edoc: documenting "-type"

Daniel Goertzen daniel.goertzen@REDACTED
Tue Jul 12 23:25:37 CEST 2011


I am trying to document a "-type" close to the top of my modules like this...

%% @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.

Thanks,
Dan.



More information about the erlang-questions mailing list