[erlang-bugs] EDoc limitations with type specs

Ricardo Catalinas Jiménez <>
Thu Mar 8 12:34:12 CET 2012


EDoc fails extracting the module documentation data when:

1. Specs are not exactly above the function they describe. For example,
this will make EDoc fail when the specs are grouped together:

    -spec foo() -> ok.
    -spec bar() -> bad.
    foo() -> ok
    bar() -> bad.

2. Type has a range with a macro, example `calendar' module from the
OTP, line 354 (R15):

    -type secs_per_day() :: 0..?SECONDS_PER_DAY.


Best regards
-- 
Ricardo (http://r.untroubled.be/)


More information about the erlang-bugs mailing list