2007 2010 Ericsson AB. All Rights Reserved.
The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

EDoc Release Notes

otp_appnotes nil
nil
nil notes.xml

This document describes the changes made to the EDoc application.

## Edoc 0.7.7

### Fixed Bugs and Malfunctions

Add encoding when parsing Wiki text. EDoc used to fail on strings such as "δεφ". (Thanks to Richard Carlsson.)

Own Id: OTP-9109

### Improvements and New Features

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

## Edoc 0.7.6.8

### Improvements and New Features

Compiler warnings were eliminated.

Own Id: OTP-8855

## Edoc 0.7.6.7

### Fixed Bugs and Malfunctions

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

Own Id: OTP-8749

## Edoc 0.7.6.6

### Improvements and New Features

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

## Edoc 0.7.6.5

### Improvements and New Features

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

## Edoc 0.7.6.4

### Improvements and New Features

Miscellaneous updates.

Own Id: OTP-8190

## Edoc 0.7.6.3

### Improvements and New Features

The copyright notices have been updated.

Own Id: OTP-7851

## Edoc 0.7.6.2

### Improvements and New Features

Minor updates.

Own Id: OTP-7642

## Edoc 0.7.6.1

### Fixed Bugs and Malfunctions

Correction to work with new versions of STDLIB that no longer has the erl_internal:obsolete/3 function.

Own Id: OTP-7539

## Edoc 0.7.6

### Improvements and New Features

Minor changes.

Own Id: OTP-7388

## Edoc 0.7.5

### Improvements and New Features

Minor updates, mostly cosmetic.

Own Id: OTP-7243

## Edoc 0.7.3

### Improvements and New Features

Minor Makefile changes.

Own Id: OTP-6689

Dialyzer warnings were eliminated.

Own Id: OTP-6737

## EDoc 0.7.2

### Fixed Bugs and Malfunctions

Some missing files have been added: ~/include/edoc_doclet.hrl, ~/priv/edoc.dtd, ~/priv/erlang.png

Own Id: OTP-6457

### Improvements and New Features

Undefined macros only cause warnings, not errors. New, built-in @version macro. Documented the @docfile and @headerfile generic tags. Added recognition of "TODO:" as a wiki equivalent for @todo tags. Added documentation about overview pages. 'where' and ',' are allowed as separators in specs. Corrected ambiguity in spec grammar (possible incompatibility issue - parentheses may need to be added in some cases, in existing code). Experimental (and undocumented) support for @param and @return tags and corresponding "..." annotations on @spec parameters.

*** POTENTIAL INCOMPATIBILITY ***

Own Id: OTP-6568

## EDoc 0.7.1

### Fixed Bugs and Malfunctions

Fixed some broken links in the documentation.

Own Id: OTP-6419

## EDoc 0.7.0

Miscellaneous changes.