This document describes the changes made to the EDoc application.
Since EDoc 0.7.7 (R14B02) separate values of union types can be annotated. However, the parser has hitherto chosen not to add the necessary parentheses due to backwards compatibility.
From this release on
code traversing the output of
*** POTENTIAL INCOMPATIBILITY ***
Own Id: OTP-10195
Support for Unicode has been implemented.
Own Id: OTP-10302
Where necessary a comment stating encoding has been added to Erlang files. The comment is meant to be removed in Erlang/OTP R17B when UTF-8 becomes the default encoding.
Own Id: OTP-10630
List behaviour callbacks in Edoc when using -callback attribute. (Thanks to Magnus Henoch.)
Added special case for file names under Windows. (Thanks to Beads Land-Trujillo.)
Own Id: OTP-10174
Miscellaneous documentation build updates
Own Id: OTP-9813
Own Id: OTP-9350
synchronized with edoc development version
forgot to ensure that xmerl is found in path for include_lib to work
fix -spec declaration that doesn't work in R13B04
eliminate warnings about unused imports
removed CVS-keywords from source files (Thanks to Richard Carlsson )
Own Id: OTP-9463
Add a proplist() type
Recently I was adding specs to an API and found that there is no canonical proplist() type defined. (Thanks to Ryan Zezeski)
Own Id: OTP-9499
Removed some never-matching clauses reported by dialyzer Fix macro expansion in comments following Erlang types URI-escape bytes as two hex digits always (reported by Alfonso De Gregorio) Updated author e-mail Recognize some more URI schemas in wiki text, in particular https (Thanks to Richard Carlsson)
Own Id: OTP-9590
Fix infinite loop for malformed edoc input
When processing an edoc comment with ``` in it, if the comment ends without a matching ''' then an infinite loop occurs in the function edoc_wiki:strip_empty_lines/2. This change fixes that by adding a clause to return from the function upon the end of the comment input. This allows an error to be thrown to indicate the problem, which is the same behaviour as leaving either `` or ` unmatched. (Thanks to Taylor Venable)
Own Id: OTP-9165
Bugs concerning the option
Own Id: OTP-9301
Add encoding when parsing Wiki text. EDoc used to fail on strings such as "δεφ". (Thanks to Richard Carlsson.)
Own Id: OTP-9109
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 (
Not all Erlang types are included in the
documentation, but only those exported by some
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.)
Own Id: OTP-8525
The
Own Id: OTP-9110
Compiler warnings were eliminated.
Own Id: OTP-8855
Edoc now uses the new API functions to
Own Id: OTP-8749
The documentation is now possible to build in an open source environment after a number of bugs are fixed and some features are added in the documentation build process.
- The arity calculation is updated.
- The module prefix used in the function names for bif's are removed in the generated links so the links will look like "http://www.erlang.org/doc/man/erlang.html#append_element-2" instead of "http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2".
- Enhanced the menu positioning in the html documentation when a new page is loaded.
- A number of corrections in the generation of man pages (thanks to Sergei Golovan)
- The legal notice is taken from the xml book file so OTP's build process can be used for non OTP applications.
Own Id: OTP-8343
The documentation is now built with open source tools (xsltproc and fop) that exists on most platforms. One visible change is that the frames are removed.
Own Id: OTP-8201
Miscellaneous updates.
Own Id: OTP-8190
The copyright notices have been updated.
Own Id: OTP-7851
Minor updates.
Own Id: OTP-7642
Correction to work with new versions of STDLIB that no
longer has the
Own Id: OTP-7539
Minor changes.
Own Id: OTP-7388
Minor updates, mostly cosmetic.
Own Id: OTP-7243
Minor Makefile changes.
Own Id: OTP-6689
Dialyzer warnings were eliminated.
Own Id: OTP-6737
Some missing files have been added:
Own Id: OTP-6457
*** POTENTIAL INCOMPATIBILITY ***
Own Id: OTP-6568
Fixed some broken links in the documentation.
Own Id: OTP-6419
Miscellaneous changes.