My fault, type should be used in specs in order to appear in the documentation<br><br>On Friday, February 1, 2013 4:47:14 PM UTC+4, Defnull wrote:<blockquote class="gmail_quote" style="margin: 0;margin-left: 0.8ex;border-left: 1px #ccc solid;padding-left: 1ex;">This syntax is broken in R15B03, I failed to make edoc use it.<br><br>On Wednesday, July 13, 2011 1:30:43 PM UTC+4, Lukas Larsson wrote:<blockquote class="gmail_quote" style="margin:0;margin-left:0.8ex;border-left:1px #ccc solid;padding-left:1ex">Hi,<br><br>It is not supported via the traditional edoc syntax, however it is supported by the new type documentation generation. If you write<br><br>
-type key() :: binary() | atom().<br>%% This type is awesome.  Really, it is great.<br><br>The comment below the type will be included in the generated edoc.<br><br>Lukas<br><br><div class="gmail_quote">On Wed, Jul 13, 2011 at 8:49 AM, Richard Carlsson <span dir="ltr"><<a>carlsson...@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div>On 2011-07-12 23:25, Daniel Goertzen wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
I am trying to document a "-type" close to the top of my modules like this...<br>
<br>
%% @doc This type is awesome.  Really, it is great.<br>
-type key() :: binary() | atom().<br>
<br>
... but it collides with my module @doc entry above it ("multiple @doc<br>
tag" error).<br>
<br>
Is there a right way to document types or is this not supported right<br>
now?  The generated documentation shows all my types nicely, but I'd<br>
love to have a bit of explanation appear with them.<br>
</blockquote>
<br></div>
It's not supported right now, but it's a good idea. Thanks.<br><font color="#888888">
<br>
    /Richard</font><div><div></div><div><br>
______________________________<u></u><wbr>_________________<br>
erlang-questions mailing list<br>
<a>erlang-q...@erlang.org</a><br>
<a href="http://erlang.org/mailman/listinfo/erlang-questions" target="_blank">http://erlang.org/mailman/<u></u>list<wbr>info/erlang-questions</a><br>
</div></div></blockquote></div><br>
</blockquote></blockquote>