Edoc thoughts
Sean Hinde
sean.hinde@REDACTED
Fri Oct 3 14:57:53 CEST 2003
On Friday, October 3, 2003, at 01:49 pm, Richard Carlsson wrote:
>
> Hello, Sean. I'd like to start by saying that I've been working on a
> new release of edoc, with major internal restructuring and many
> improvements, and I hope to release it in a not too distant future.
> (I know I've been saying this for a while now...)
This is great news. Need a beta tester?
> - The things to the right of the '::', and the thing that follows the
> '->' are _types_. In addition, you can list further local definitions.
> Your example can be written:
>
> % @spec read_customer(Msisdn::string(), Operator::atom()) ->
> % {ok, Number, Services} | not_likely
> % Number = string()
> % Services = services()
Yes, this was actually in the documentation.. The additional
explanation is most welcome though.
>> 3. This last could probably be an exercise for the reader (or writer?)
>> but an edoc:directory(string()) or even
>> edoc:application(Otp_app::atom()) mechanism to do all files and
>> generate an overview page would be the icing on the cake for this
>> excellent time saver.
>
> I'm working on it. :-)
Splendid, can't wait!
Cheers,
Sean
More information about the erlang-questions
mailing list