From 6945881b99aeadaf9ed4ec1f8c7811538cee1405 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:03:38 +0200 Subject: [edoc] Correct documentation Fix mistakes found by 'xmllint'. --- lib/edoc/doc/overview.edoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'lib/edoc/doc/overview.edoc') diff --git a/lib/edoc/doc/overview.edoc b/lib/edoc/doc/overview.edoc index 3639bb43a5..d2bba9d744 100644 --- a/lib/edoc/doc/overview.edoc +++ b/lib/edoc/doc/overview.edoc @@ -755,7 +755,7 @@ following escape sequences may be used:
=== Function specifications === -Although the syntax described in the following can still be used +Note that although the syntax described in the following can still be used for specifying functions we recommend that Erlang specifications as described in Types and Function Specification should be added to the source @@ -764,7 +764,6 @@ marker="dialyzer:dialyzer">Dialyzer's can be utilized in the process of keeping the documentation consistent and up-to-date. Erlang specifications will be used unless there is also a function specification (a `@spec' tag followed by a type) with the same name. - The following grammar describes the form of the specifications following a `@spec' tag. A '`?'' suffix implies that the element is optional. @@ -973,12 +972,12 @@ contain any annotations at all. === Type definitions === -Although the syntax described in the following can still be used +Note that although the syntax described in the following can still be used for specifying types we recommend that Erlang types as described in Types and Function Specification should be added to the source code instead. Erlang types will be used unless there is a type alias with the same -name. +name. The following grammar (see above for auxiliary definitions) describes the form of the definitions that may follow a `@type' tag: -- cgit v1.2.3