aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/doc/overview.edoc
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2015-10-13 14:03:38 +0200
committerHans Bolinder <[email protected]>2016-01-26 13:03:17 +0100
commit6945881b99aeadaf9ed4ec1f8c7811538cee1405 (patch)
tree37424ff28bd5629d85a8725f106fb8012ae343ff /lib/edoc/doc/overview.edoc
parent42d798aef0f435d0027c836949a26cc699e7e9ae (diff)
downloadotp-6945881b99aeadaf9ed4ec1f8c7811538cee1405.tar.gz
otp-6945881b99aeadaf9ed4ec1f8c7811538cee1405.tar.bz2
otp-6945881b99aeadaf9ed4ec1f8c7811538cee1405.zip
[edoc] Correct documentation
Fix mistakes found by 'xmllint'.
Diffstat (limited to 'lib/edoc/doc/overview.edoc')
-rw-r--r--lib/edoc/doc/overview.edoc7
1 files changed, 3 insertions, 4 deletions
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: <dl>
=== Function specifications ===
-<note>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 <seealso marker="doc/reference_manual:typespec"> Types
and Function Specification</seealso> should be added to the source
@@ -764,7 +764,6 @@ marker="dialyzer:dialyzer">Dialyzer</seealso>'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.
-</note>
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 ===
-<note>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
<seealso marker="doc/reference_manual:typespec"> Types and Function
Specification</seealso> should be added to the source code instead.
Erlang types will be used unless there is a type alias with the same
-name.</note>
+name.
The following grammar (see above for auxiliary definitions) describes
the form of the definitions that may follow a `@type' tag: