aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/doc/overview.edoc
AgeCommit message (Collapse)Author
2015-03-12edoc: Correct documentationHans Bolinder
Substitute references to edoc_lib:get_doc_env/3 for references to edoc_lib:get_doc_env/4.
2015-01-16[edoc] remove functionality related to packagesVlad Dumitrescu
The 'subpackages' option is left, since some projects use recursive source directories.
2011-09-25updated author e-mailRichard Carlsson
2011-08-04synchronized with edoc development versionRichard Carlsson
2011-03-10Make Erlang specifications and types available in EDocHans Bolinder
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.
2009-11-20The R13B03 release.OTP_R13B03Erlang/OTP