[erlang-questions] edoc questions
Mon Dec 4 16:38:55 CET 2006
Michael McDaniel wrote:
> On Mon, Dec 04, 2006 at 04:14:00PM +0100, Fredrik Thulin wrote:
>> Michael McDaniel wrote:
>>> first question, please see below ...
>>>> How can I preserve the explanatory text for Dst?
>> Can you please be more specific? At the linked page, I found functions
> Please look back at my original post. I commented your function.
> Other than the misplaced @author tag I, the tags compile and keep
> your explanatory text verbatim.
> %% @doc
> %% <pre>
> %% all Fredrik's comments
> %% </pre>
> %% @end
Ahh, I see. You meant that I should include all my original stuff as
@doc. I didn't get that.
Well, I guess that would work but I would be loosing out of something
I've heard plans of - getting Dialyzer to benefit from type declarations
in edoc format, and also pointing out to you when you've failed to make
your documentation match your implementation ;).
That was actually what made me want to spend all the time and energy it
would require to transform my documentation into edoc format.
More information about the erlang-questions