| Age | Commit message (Collapse) | Author |
|---|
|
|
|
This makes it clear that Apache 2.0 applies, without dropping the old LGPL
licensing, and makes all the EDoc file headers look the same as upstream.
|
|
An attempt to shut off Dialyzer's unmatched return warnings made
a change that simply ignored the return type of a function.
It's arguably better to modify the code of this function to not
return something "by accident." While at it, rewrote a slighty
confusing use of a list comprehension without a generator to a
case statement.
|
|
|
|
The 'subpackages' option is left, since some projects use recursive
source directories.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Bugs concerning the option report_missing_types that was added in
EDoc-0.7.7 have been corrected: the option was misspelled in the
source, and local definitions as well as the function tags @private
and @hidden were not handled correctly. (Thanks to Manolis Papadakis.)
|
|
It is now possible to use Erlang specifications and types in EDoc
documentation. Erlang specifications and types will be used unless
there is also a function specification (@spec) or a type alias (@type)
with the same name. In the current implementation the placement of
-spec matters: it should be placed where the @spec would otherwise
have been placed.
Not all Erlang types are included in the documentation, but only those
exported by some export_type declaration or used by some documented
Erlang specification (-spec).
There is currently no support for overloaded Erlang specifications.
The syntax definitions of EDoc have been augmented to cope with most
of the Erlang types. (But we recommend that Erlang types should be
used instead.)
edoc:read_source() takes one new option, report_missing_types.
edoc_layout:module() takes one new option, pretty_printer.
|
|
Add appropriate specs to shut off dialyzer's no_return warnings and
also fix an erroneous use of lists:concat/1 instead of lists:append/1.
|
|
|
