Age | Commit message (Collapse) | Author | |
---|---|---|---|
2012-08-08 | List behaviour callbacks in Edoc when using -callback attribute | Magnus Henoch | |
Defining a behaviour_info/1 function is no longer the only way to define a behaviour; you can use -callback attributes as well. This change makes edoc aware of the latter, such that the module documentation page for a behaviour module will list the name and arity of the required callback functions. Ideally, edoc should use the type information present in the callback attributes, but with this change, the documentation is at least no worse than when using an explicit behaviour_info function. | |||
2011-09-25 | updated author e-mail | Richard Carlsson | |
2011-08-04 | removed CVS-keywords from source files | Richard Carlsson | |
2011-03-10 | Make Erlang specifications and types available in EDoc | Hans 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-20 | The R13B03 release.OTP_R13B03 | Erlang/OTP | |