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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">
<chapter>
<header>
<copyright>
<year>2004</year><year>2018</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions 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 <em>erl_docgen</em> application.</p>
<section><title>Erl_Docgen 1.0.1</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Repaired lost function "since" versions in the right
margin of the module reference HTML documentation.</p>
<p>
Own Id: OTP-16661 Aux Id: ERL-1259 </p>
</item>
<item>
<p>Remove erlang compilation warnings and trailing
whitespaces.</p>
<p>
Own Id: OTP-16675</p>
</item>
</list>
</section>
</section>
<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>
<item>
<p>Fixed a cosmetic formatting bug in the data types
section of generated HTML documentation.</p>
<p>
Own Id: OTP-15940</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
Added support for specifying what language a code snippet
should be highlighted as.</p>
<p>
Updated the code examples syntax highlighting library.</p>
<p>
Own Id: OTP-16209</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.10</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Update the documentation build support to handle FOP
2.1 . </p>
<p>
Own Id: OTP-16051</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.9.1</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
All incorrect (that is, all) uses of "can not" has been
corrected to "cannot" in source code comments,
documentation, examples, and so on.</p>
<p>
Own Id: OTP-14282 Aux Id: PR-1891 </p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.9</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
The HTML reference documentation shows the OTP version
where modules and functions were first introduced.
Versions older than R13B04 are not shown.</p>
<p>
Own Id: OTP-15460</p>
</item>
<item>
<p>
Make html documentation of C functions with many
arguments more readable.</p>
<p>
Own Id: OTP-15637 Aux Id: PR-2160 </p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.8.1</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Indexing for the online search function has been
corrected for CREF documents.</p>
<p>
Own Id: OTP-14406</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.8</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
Add a hoverable element to the titles in the html
documentation with a link to github where the
documentation can be edited.</p>
<p>
Make the anchors in the html User's Guide and system
documentation use the title of the sections instead of a
generated id.</p>
<p>
Own Id: OTP-14979</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.7.3</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Update makefile so db_funcs.xsl is a part of the
installed application. </p>
<p>
Own Id: OTP-15091</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.7.2</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> The style for code, warning and note tags in the pdf
have been changed so they look like the html version.
<br/> The spacing around code blocks have been changed
for both html and pdf so it's the same regardless if the
user have a newline after the start tag (or before the
end tag) or not. </p>
<p>
Own Id: OTP-14674</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.7.1</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
General Unicode improvements.</p>
<p>
Own Id: OTP-14462</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.7</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Sort index of C functions alphabetically in the sidebar.</p>
<p>
Own Id: OTP-14333 Aux Id: ERL-393 </p>
</item>
<item>
<p> The right side index of functions now handle
functions with same name but different arity. </p>
<p>
Own Id: OTP-14431</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
Improvements in the OTP documentation style.</p>
<p>
(Thanks to Mariano Guerra)</p>
<p>
Own Id: OTP-14371 Aux Id: PR-1215 </p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.6.1</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Docgen would previously emit "utf8" as the default
encoding in xml. This has now been remedied by emitting
the correct string "UTF-8" instead.</p>
<p>
Own Id: OTP-13971</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.6</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>Improve types and specs in OTP documentation generated
from Erlang source files. </p>
<p>
Own Id: OTP-13720 Aux Id: ERL-120 </p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.5</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Generate HTML anchors for data types without
<c>name</c> attribute. </p>
<p>
Own Id: OTP-13600 Aux Id: Jira: ERL-141 </p>
</item>
<item>
<p> Updated make rules so it's possible to use the
xmllint target for checking the system
documentation.<br/> Removed usage of non defined DTD tag
(output) from the system documentation and corrected a
number of xml faults. </p> <p> Added support for quote
tag and a new level of header formatting in erl_docgen.
</p> <p> A fault when generating html for manual set
markers for section headings is corrected so now is the
title visible after hyperlink jump. </p>
<p>
Own Id: OTP-13638</p>
</item>
<item>
<p> Corrected the space handling for the seealso tag.
</p>
<p>
Own Id: OTP-13639</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Sort the modules function index alphabetically. </p>
<p>
Own Id: OTP-13668 Aux Id: PR-543 </p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.4.2</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Correctly generate anno tags for maps keys</p>
<p>
Own Id: OTP-12955</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.4.1</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Updated the xmllint target to just check the xml
files with real documentation content.<br/> Corrected
some errors and added some missing target in the DTD's.
</p>
<p>
Own Id: OTP-13026</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.4</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Add possibility to add extra information on
documentation front pages. </p>
<p>
Own Id: OTP-12722</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.7</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Maps: Properly align union typed assoc values in
documentation</p>
<p>
Own Id: OTP-12190</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.6</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Fix spec to doc generation from erl_docgen and edoc for
maps</p>
<p>
Own Id: OTP-12058</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.5</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p>
Application upgrade (appup) files are corrected for the
following applications: </p>
<p>
<c>asn1, common_test, compiler, crypto, debugger,
dialyzer, edoc, eldap, erl_docgen, et, eunit, gs, hipe,
inets, observer, odbc, os_mon, otp_mibs, parsetools,
percept, public_key, reltool, runtime_tools, ssh,
syntax_tools, test_server, tools, typer, webtool, wx,
xmerl</c></p>
<p>
A new test utility for testing appup files is added to
test_server. This is now used by most applications in
OTP.</p>
<p>
(Thanks to Tobias Schlager)</p>
<p>
Own Id: OTP-11744</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
Handle map types in docgen_edoc_xml_cb</p>
<p>
Own Id: OTP-11776</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.4.1</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p>
The encoding of the <c>notes.xml</c> file has been
changed from latin1 to utf-8 to avoid future merge
problems.</p>
<p>
Own Id: OTP-11310</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.4</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Correct a PDF indentation bug for tagged lists in
tagged lists and added some missing tags to the DTD. </p>
<p>
Own Id: OTP-10725</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Support for Unicode has been implemented. </p>
<p>
Own Id: OTP-10302</p>
</item>
<item>
<p>Where necessary a comment stating encoding has been
added to Erlang files. The comment is meant to be removed
in Erlang/OTP R17B when UTF-8 becomes the default
encoding. </p>
<p>
Own Id: OTP-10630</p>
</item>
<item>
<p> Some examples overflowing the width of PDF pages have
been corrected. </p>
<p>
Own Id: OTP-10665</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.3</title>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> A possibility to configure erl_docgen so it can
generate documentation for other products than
Erlang/OTP. </p>
<p>
Own Id: OTP-9040</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.2</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> A bug regarding spaces in C function prototypes has
been fixed. (Thanks to Richard O'Keefe.) </p>
<p>
Own Id: OTP-10138</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3.1</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Some links in C libraries were not generated
correctly. This bug has been fixed. </p>
<p>
Own Id: OTP-9832</p>
</item>
<item>
<p>
Set `font-family: Courier, monospace' in OTP doc CSS</p>
<p>
left Courier as the primary original font and also added
monospace as secondary for people which in Linux does not
have it installed.</p>
<p>
Also adds minor cosmetic changes to the CSS. (Thanks to
Ricardo Catalinas Jiménez)</p>
<p>
Own Id: OTP-9918</p>
</item>
<item>
<p>
When generating from edoc it is now possible to use
ranges in specs and <img> tags in the description.</p>
<p>
Own Id: OTP-9970</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> Optimize and improve handling of multiple func:s.
</p>
<p>
Own Id: OTP-9877</p>
</item>
<item>
<p> The generation of the libraries' HTML documentation
has been optimized. </p>
<p>
Own Id: OTP-9893</p>
</item>
</list>
</section>
</section>
<section><title>Erl_Docgen 0.3</title>
<section><title>Fixed Bugs and Malfunctions</title>
<list>
<item>
<p> Bug fixes concerning the generation of manpages. </p>
<p>
Own Id: OTP-9614</p>
</item>
<item>
<p> Fix syntax bug in eix files. </p>
<p>
Own Id: OTP-9617</p>
</item>
<item>
<p> Bug fix concerning the generation of manpages. </p>
<p>
Own Id: OTP-9759</p>
</item>
<item>
<p> Fixed an arity calculation bug for erlang functions
in the documentation index for html and pdf. </p>
<p>
Own Id: OTP-9772</p>
</item>
</list>
</section>
<section><title>Improvements and New Features</title>
<list>
<item>
<p> The docbuilder application is removed in R15 and
parts still used in the OTP documentation build process
and the DTD documentation is moved to erl_docgen. </p>
<p>
Own Id: OTP-9721</p>
</item>
</list>
</section>
</section>
<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>
|