User's Guide
Reference Manual
Release Notes
PDF
Top

EDoc
Release Notes
Version 0.7.6.6

Expand All
Contract All

Chapters

- EDoc Release Notes
  - Top of chapter
  - Edoc 0.7.6.6
  - Edoc 0.7.6.5
  - Edoc 0.7.6.4
  - Edoc 0.7.6.3
  - Edoc 0.7.6.2
  - Edoc 0.7.6.1
  - Edoc 0.7.6
  - Edoc 0.7.5
  - Edoc 0.7.3
  - EDoc 0.7.2
  - EDoc 0.7.1
  - EDoc 0.7.0

# 1 EDoc Release Notes

This document describes the changes made to the EDoc application.

### 1.1 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

### 1.2 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

### 1.3 Edoc 0.7.6.4

#### Improvements and New Features

- Miscellaneous updates.

  Own Id: OTP-8190

### 1.4 Edoc 0.7.6.3

#### Improvements and New Features

- The copyright notices have been updated.

  Own Id: OTP-7851

### 1.5 Edoc 0.7.6.2

#### Improvements and New Features

- Minor updates.

  Own Id: OTP-7642

### 1.6 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

### 1.7 Edoc 0.7.6

#### Improvements and New Features

- Minor changes.

  Own Id: OTP-7388

### 1.8 Edoc 0.7.5

#### Improvements and New Features

- Minor updates, mostly cosmetic.

  Own Id: OTP-7243

### 1.9 Edoc 0.7.3

#### Improvements and New Features

- Minor Makefile changes.

  Own Id: OTP-6689

- Dialyzer warnings were eliminated.

  Own Id: OTP-6737

### 1.10 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

### 1.11 EDoc 0.7.1

#### Fixed Bugs and Malfunctions

- Fixed some broken links in the documentation.

  Own Id: OTP-6419

### 1.12 EDoc 0.7.0

Miscellaneous changes.