Update to use the new string api instead of the old.

Own Id: OTP-15036

The map type is correctly denoted as map() in function specifications and types.

Own Id: OTP-14777

Tools are updated to show Unicode atoms correctly.

Own Id: OTP-14464

To support stable builds, edoc no longer includes time stamps in the footer for generated files.

Own Id: OTP-14277

Miscellaneous updates due to atoms containing arbitrary Unicode characters.

Own Id: OTP-14285

Document the function tags @param and @returns.

Own Id: OTP-13930 Aux Id: PR-1175

Improve types and specs in OTP documentation generated from Erlang source files.

Own Id: OTP-13720 Aux Id: ERL-120

Handle typed record fields.

Own Id: OTP-13558

Assign correct names to list arguments.

Own Id: OTP-13234 Aux Id: ERL-63

Unless the sort_functions option is true, edoc_layout does not sort functions.

Own Id: OTP-13302

Remove functionality related to packages

Own Id: OTP-12431

Maps: Properly align union typed assoc values in documentation

Own Id: OTP-12190

Fix spec to doc generation from erl_docgen and edoc for maps

Own Id: OTP-12058

The default encoding for Erlang source files is now UTF-8. As a temporary measure to ease the transition from the old default of Latin-1, if EDoc encounters byte sequences that are not valid UTF-8 sequences, EDoc will re-try in Latin-1 mode. This workaround will be removed in a future release.

Own Id: OTP-12008

Application upgrade (appup) files are corrected for the following applications:

asn1, common_test, compiler, crypto, debugger, dialyzer, edoc, eldap, erl_docgen, et, eunit, gs, hipe, inets, observer, odbc, os_mon, otp_mibs, parsetools, percept, public_key, reltool, runtime_tools, ssh, syntax_tools, test_server, tools, typer, webtool, wx, xmerl

A new test utility for testing appup files is added to test_server. This is now used by most applications in OTP.

(Thanks to Tobias Schlager)

Own Id: OTP-11744

The encoding of the notes.xml file has been changed from latin1 to utf-8 to avoid future merge problems.

Own Id: OTP-11310

EDoc sometimes failed to associate a comment with the preceding type declaration. This bug has been fixed. (Thanks to Serge Aleynikov for reporting the bug.)

Own Id: OTP-10866

Miscellaneous updates due to Unicode support.

Own Id: OTP-10820

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 edoc_parser needs to take care of parentheses around separate values of union types. Examples of such code are layout modules and doclet modules.

*** 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

no_return is a new built-in type.

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 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.)

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 (@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.

Own Id: OTP-8525

The edoc_lib module is meant to be private, but since it is referred to from other man pages it has been included in the OTP documentation. The modifications introduced in this ticket make all functions private except those referred to from other pages.

Own Id: OTP-9110

Compiler warnings were eliminated.

Own Id: OTP-8855

Edoc now uses the new API functions to inets instead of the deprecated ones.

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 erl_internal:obsolete/3 function.

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