[erlang-questions] edoc: documenting "-type"
Wed Jul 13 08:49:17 CEST 2011
On 2011-07-12 23:25, Daniel Goertzen wrote:
> 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.
It's not supported right now, but it's a good idea. Thanks.
More information about the erlang-questions