1 Erl_Docgen Release Notes

This document describes the changes made to the erl_docgen application.

1.1 Erl_Docgen 0.4

Improvements and New Features

Add possibility to add extra information on documentation front pages.

Own Id: OTP-12722

1.2 Erl_Docgen 0.3.7

Fixed Bugs and Malfunctions

Maps: Properly align union typed assoc values in documentation

Own Id: OTP-12190

1.3 Erl_Docgen 0.3.6

Fixed Bugs and Malfunctions

Fix spec to doc generation from erl_docgen and edoc for maps

Own Id: OTP-12058

1.4 Erl_Docgen 0.3.5

Fixed Bugs and Malfunctions

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

Improvements and New Features

Handle map types in docgen_edoc_xml_cb

Own Id: OTP-11776

1.5 Erl_Docgen 0.3.4.1

Improvements and New Features

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

Own Id: OTP-11310

1.6 Erl_Docgen 0.3.4

Fixed Bugs and Malfunctions

Correct a PDF indentation bug for tagged lists in tagged lists and added some missing tags to the DTD.

Own Id: OTP-10725

Improvements and New Features

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
Some examples overflowing the width of PDF pages have been corrected.

Own Id: OTP-10665

1.7 Erl_Docgen 0.3.3

Improvements and New Features

A possibility to configure erl_docgen so it can generate documentation for other products than Erlang/OTP.

Own Id: OTP-9040

1.8 Erl_Docgen 0.3.2

Fixed Bugs and Malfunctions

A bug regarding spaces in C function prototypes has been fixed. (Thanks to Richard O'Keefe.)

Own Id: OTP-10138

1.9 Erl_Docgen 0.3.1

Fixed Bugs and Malfunctions

Some links in C libraries were not generated correctly. This bug has been fixed.

Own Id: OTP-9832
Set `font-family: Courier, monospace' in OTP doc CSS

left Courier as the primary original font and also added monospace as secondary for people which in Linux does not have it installed.

Also adds minor cosmetic changes to the CSS. (Thanks to Ricardo Catalinas Jiménez)

Own Id: OTP-9918
When generating from edoc it is now possible to use ranges in specs and <img> tags in the description.

Own Id: OTP-9970

Improvements and New Features

Optimize and improve handling of multiple func:s.

Own Id: OTP-9877
The generation of the libraries' HTML documentation has been optimized.

Own Id: OTP-9893

1.10 Erl_Docgen 0.3

Fixed Bugs and Malfunctions

Bug fixes concerning the generation of manpages.

Own Id: OTP-9614
Fix syntax bug in eix files.

Own Id: OTP-9617
Bug fix concerning the generation of manpages.

Own Id: OTP-9759
Fixed an arity calculation bug for erlang functions in the documentation index for html and pdf.

Own Id: OTP-9772

Improvements and New Features

The docbuilder application is removed in R15 and parts still used in the OTP documentation build process and the DTD documentation is moved to erl_docgen.

Own Id: OTP-9721

1.11 Erl_Docgen 0.2.6

Fixed Bugs and Malfunctions

Bug fixes.

Own Id: OTP-9360
The manpage generation has been improved.

Own Id: OTP-9541 Aux Id: OTP-9550
Fix eix file generation for new function spec references.

Own Id: OTP-9562
The function signatures in the pdf files was not in a fixed font.

Own Id: OTP-9563
The parts level in the system documentation was missing in the bookmarks menu for the pdf and the copyright year generation for PDF was not correct.

Own Id: OTP-9576
The indentation after Warning: and Note: in manpages has been improved.

Own Id: OTP-9588

1.12 Erl_Docgen 0.2.5

Improvements and New Features

The support for using Erlang specifications and types has been improved.

Own Id: OTP-9261

1.13 erl_docgen 0.2.4

Fixed Bugs and Malfunctions

Subsections below level 2 where not handled correct when generating html and pdf.

Own Id: OTP-90730

1.14 erl_docgen 0.2.3

Fixed Bugs and Malfunctions

Fix format_man_pages so it handles all man sections and remove warnings/errors in various man pages.

Own Id: OTP-8600

Improvements and New Features

Support for using Dialyzer specifications and types has been added. This is an experimental release; changes are expected before the new functionality is used when building the OTP documentation.

Own Id: OTP-8720

1.15 erl_docgen 0.2.2

Fixed Bugs and Malfunctions

Fixed the transformation from xml to html of the funcs block in comref pages.

Own Id: OTP-8792

1.16 erl_docgen 0.2.1

Fixed Bugs and Malfunctions

The text within code examples (CODE and PRE tags) will not be space normalized for man pages.

Own Id: OTP-8476

1.17 erl_docgen 0.2

Improvements and New Features

Added an xsl transform from OTP xml documentation to a file (.eix) of erlang terms that can be read by the erldoc application. Erldoc handles the documentation search mechanism at erlang.org. Added generation of eix files to otp_release_targets.mk. Fixed a copyright date error in db_html.xsl .

Own Id: OTP-8308
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

1.18 erl_docgen 0.1

Improvements and new features

This is the first release of erl_docgen for internal use.