summaryrefslogtreecommitdiff
path: root/lib/erl_docgen/doc
diff options
context:
space:
mode:
authorErlang/OTP <otp@erlang.org>2020-04-22 09:12:49 +0200
committerErlang/OTP <otp@erlang.org>2020-04-22 09:12:49 +0200
commiteee1f3aba92b5a741eabfa1cb6eca0632562777a (patch)
treef88761d2d882dca0e2dd8097c7d2e8238e5fa8b1 /lib/erl_docgen/doc
parent3fc3fc62e96de08f6e91ae546079733160bf5acd (diff)
downloaderlang-eee1f3aba92b5a741eabfa1cb6eca0632562777a.tar.gz
Prepare release
Diffstat (limited to 'lib/erl_docgen/doc')
-rw-r--r--lib/erl_docgen/doc/src/notes.xml48
1 files changed, 47 insertions, 1 deletions
diff --git a/lib/erl_docgen/doc/src/notes.xml b/lib/erl_docgen/doc/src/notes.xml
index e5076a4790..08bcc3d8da 100644
--- a/lib/erl_docgen/doc/src/notes.xml
+++ b/lib/erl_docgen/doc/src/notes.xml
@@ -31,7 +31,53 @@
</header>
<p>This document describes the changes made to the <em>erl_docgen</em> application.</p>
- <section><title>Erl_Docgen 0.11</title>
+ <section><title>Erl_Docgen 1.0</title>
+
+ <section><title>Improvements and New Features</title>
+ <list>
+ <item>
+ <p>
+ Embedded documentation (also known as Documentation
+ Chunks) is now also available in the form of files
+ according to <url
+ href="https://www.erlang.org/erlang-enhancement-proposals/eep-0048.html">EEP-48</url>.
+ The Documentation Chunks are produced by default when
+ building the other Erlang/OTP documentation. If you want
+ to only build the embedded documentation you can pass the
+ <c>DOC_TARGETS=chunks</c> environment variable to make.</p>
+ <p>
+ Own Id: OTP-16406</p>
+ </item>
+ <item>
+ <p>
+ Minor DTD additions.</p>
+ <p>
+ Own Id: OTP-16497</p>
+ </item>
+ <item>
+ <p>
+ The <c>seealso</c> tag has been replaced with type aware
+ tags instead. The new tags are:
+ <c>seemfa|seeerl|seetype|seeapp|seecom|seecref|seefile|seeguide</c>.</p>
+ <p>
+ <c>fsdescription</c> has been added for adding a title to
+ groups of functions, for instance Module Callbacks.</p>
+ <p>
+ The <c>dtd</c>s of all documentation files have been
+ trimmed from all unused or rarely-used tags.</p>
+ <p>
+ Unused <c>dtd</c>s have been removed.</p>
+ <p>
+ *** POTENTIAL INCOMPATIBILITY ***</p>
+ <p>
+ Own Id: OTP-16503</p>
+ </item>
+ </list>
+ </section>
+
+</section>
+
+<section><title>Erl_Docgen 0.11</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>