blob: 6a0eece56d7c548af8d00eaf35b1ce779275baaf (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">
<chapter>
<header>
<copyright>
<year>2004</year><year>2011</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
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.
</legalnotice>
<title>erl_docgen Release Notes</title>
<prepared>otp_appnotes</prepared>
<docno>nil</docno>
<date>nil</date>
<rev>nil</rev>
<file>notes.xml</file>
</header>
<p>This document describes the changes made to the erl_docgen application.</p>
<section><title>Erl_Docgen 0.2.6</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>Bug fixes. </p>
<p>
Own Id: OTP-9360</p>
</item>
<item>
<p> The manpage generation has been improved. </p>
<p>
Own Id: OTP-9541 Aux Id: OTP-9550 </p>
</item>
<item>
<p> Fix eix file generation for new function spec
references. </p>
<p>
Own Id: OTP-9562</p>
</item>
<item>
<p> The function signatures in the pdf files was not in a
fixed font. </p>
<p>
Own Id: OTP-9563</p>
</item>
<item>
<p> The parts level in the system documentation was
missing in the bookmarks menu for the pdf and the
copyright year generation for PDF was not correct. </p>
<p>
Own Id: OTP-9576</p>
</item>
<item>
<p> The indentation after <c>Warning:</c> and
<c>Note:</c> in manpages has been improved. </p>
<p>
Own Id: OTP-9588</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.2.5</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> The support for using Erlang specifications and types
has been improved. </p>
<p>
Own Id: OTP-9261</p>
</item>
</list>
</section>
</section>
<section><title>erl_docgen 0.2.4</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>Subsections below level 2 where not handled correct when generating html and pdf.</p>
<p>
Own Id: OTP-90730</p>
</item>
</list>
</section>
</section>
<section><title>erl_docgen 0.2.3</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Fix format_man_pages so it handles all man sections
and remove warnings/errors in various man pages. </p>
<p>
Own Id: OTP-8600</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Support for using Dialyzer specifications and types
has been added. This is an experimental release; changes
are expected before the new functionality is used when
building the OTP documentation. </p>
<p>
Own Id: OTP-8720</p>
</item>
</list>
</section>
</section>
<section><title>erl_docgen 0.2.2</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Fixed the transformation from xml to html of the
funcs block in comref pages. </p>
<p>
Own Id: OTP-8792</p>
</item>
</list>
</section>
</section>
<section><title>erl_docgen 0.2.1</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
The text within code examples (CODE and PRE tags) will not be
space normalized for man pages.
</p>
<p>
Own Id: OTP-8476
</p>
</item>
</list>
</section>
</section>
<section><title>erl_docgen 0.2</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
Added an xsl transform from OTP xml documentation to a
file (.eix) of erlang terms that can be read by the
erldoc application. Erldoc handles the documentation
search mechanism at erlang.org. Added generation of eix
files to otp_release_targets.mk. Fixed a copyright date
error in db_html.xsl .</p>
<p>
Own Id: OTP-8308</p>
</item>
<item>
<p>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. </p>
<p>- The arity calculation is updated.</p>
<p>- 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".</p>
<p>- Enhanced the menu positioning in the html
documentation when a new page is loaded.</p>
<p>- A number of corrections in the generation of man
pages (thanks to Sergei Golovan)</p>
<p>- The legal notice is taken from the xml book file so
OTP's build process can be used for non OTP
applications.</p>
<p>
Own Id: OTP-8343</p>
</item>
</list>
</section>
</section>
<section><title>erl_docgen 0.1</title>
<section>
<title>Improvements and new features</title>
<p>This is the first release of erl_docgen for internal use.</p>
</section>
</section>
</chapter>
|
