1  Erl_Docgen Release Notes

1 Erl_Docgen Release Notes

This document describes the changes made to the erl_docgen application.

  • Any exported, but private function or module in Erlang/OTP now generate an EEP-48 style documentation entry with the content set to hidden.

    Before this change, exported but private functions and modules did not have any entry at all.

    Own Id: OTP-17669 Aux Id: PR-5226

  • Fix codeinclude tag to correctly respect the type attribute.

    Own Id: OTP-17754 Aux Id: PR-5365

  • The HTML documentation has been updated to collapse better on small screens.

    Own Id: OTP-17687 Aux Id: PR-5197

  • All predefined types have been added to the erlang module together with documentation.

    Any reference to a predefined type now links to that documentation so that the user can view it.

    Own Id: OTP-17689 Aux Id: PR-5292

  • Fix codeinclude tags to work as part of reference manual documentation.

    Own Id: OTP-17458 Aux Id: PR-4764

  • Fix creation of link elements with anchors in EEP-48 style documentation.

    Own Id: OTP-17575 Aux Id: PR-5132

  • Fix links generated in specs to types in other applications to point to the correct place. This bug was introduced in Erlang/OTP 24.0.

    Own Id: OTP-17433 Aux Id: GH-4849 PR-4857

  • Fixed bug in shell_docs and erl_docgen that interpreted em tags as strong.

    Own Id: OTP-17122

  • Missing runtime dependencies has been added to this application.

    Own Id: OTP-17243 Aux Id: PR-4557

  • Fix bug where see* elements within type/name were removed when generating html. Bug has been present since OTP-21.

    Own Id: OTP-17257

  • Add support for displaying .svg images.

    Own Id: OTP-16877

  • Updated the way specs are generated after changes in edoc.

    Own Id: OTP-17192 Aux Id: PR-2803

  • Fix links in titles to github and anchors to work.

    Own Id: OTP-17013

  • Fix some typing errors on variable names in documentation examples.

    Own Id: OTP-17065 Aux Id: ERL-1386

  • Repaired lost function "since" versions in the right margin of the module reference HTML documentation.

    Own Id: OTP-16661 Aux Id: ERL-1259

  • Remove erlang compilation warnings and trailing whitespaces.

    Own Id: OTP-16675

  • Embedded documentation (also known as Documentation Chunks) is now also available in the form of files according to EEP-48. 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 DOC_TARGETS=chunks environment variable to make.

    Own Id: OTP-16406

  • Minor DTD additions.

    Own Id: OTP-16497

  • The seealso tag has been replaced with type aware tags instead. The new tags are: seemfa|seeerl|seetype|seeapp|seecom|seecref|seefile|seeguide.

    fsdescription has been added for adding a title to groups of functions, for instance Module Callbacks.

    The dtds of all documentation files have been trimmed from all unused or rarely-used tags.

    Unused dtds have been removed.

    *** POTENTIAL INCOMPATIBILITY ***

    Own Id: OTP-16503

  • Fixed a cosmetic formatting bug in the data types section of generated HTML documentation.

    Own Id: OTP-15940

  • Added support for specifying what language a code snippet should be highlighted as.

    Updated the code examples syntax highlighting library.

    Own Id: OTP-16209

  • Update the documentation build support to handle FOP 2.1 .

    Own Id: OTP-16051

  • All incorrect (that is, all) uses of "can not" has been corrected to "cannot" in source code comments, documentation, examples, and so on.

    Own Id: OTP-14282 Aux Id: PR-1891

  • The HTML reference documentation shows the OTP version where modules and functions were first introduced. Versions older than R13B04 are not shown.

    Own Id: OTP-15460

  • Make html documentation of C functions with many arguments more readable.

    Own Id: OTP-15637 Aux Id: PR-2160

  • Indexing for the online search function has been corrected for CREF documents.

    Own Id: OTP-14406

  • Add a hoverable element to the titles in the html documentation with a link to github where the documentation can be edited.

    Make the anchors in the html User's Guide and system documentation use the title of the sections instead of a generated id.

    Own Id: OTP-14979

  • Update makefile so db_funcs.xsl is a part of the installed application.

    Own Id: OTP-15091

  • The style for code, warning and note tags in the pdf have been changed so they look like the html version.
    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.

    Own Id: OTP-14674

  • General Unicode improvements.

    Own Id: OTP-14462

  • Sort index of C functions alphabetically in the sidebar.

    Own Id: OTP-14333 Aux Id: ERL-393

  • The right side index of functions now handle functions with same name but different arity.

    Own Id: OTP-14431

  • Improvements in the OTP documentation style.

    (Thanks to Mariano Guerra)

    Own Id: OTP-14371 Aux Id: PR-1215

  • Docgen would previously emit "utf8" as the default encoding in xml. This has now been remedied by emitting the correct string "UTF-8" instead.

    Own Id: OTP-13971

  • Improve types and specs in OTP documentation generated from Erlang source files.

    Own Id: OTP-13720 Aux Id: ERL-120

  • Generate HTML anchors for data types without name attribute.

    Own Id: OTP-13600 Aux Id: Jira: ERL-141

  • Updated make rules so it's possible to use the xmllint target for checking the system documentation.
    Removed usage of non defined DTD tag (output) from the system documentation and corrected a number of xml faults.

    Added support for quote tag and a new level of header formatting in erl_docgen.

    A fault when generating html for manual set markers for section headings is corrected so now is the title visible after hyperlink jump.

    Own Id: OTP-13638

  • Corrected the space handling for the seealso tag.

    Own Id: OTP-13639

  • Sort the modules function index alphabetically.

    Own Id: OTP-13668 Aux Id: PR-543

  • Correctly generate anno tags for maps keys

    Own Id: OTP-12955

  • Updated the xmllint target to just check the xml files with real documentation content.
    Corrected some errors and added some missing target in the DTD's.

    Own Id: OTP-13026

  • Add possibility to add extra information on documentation front pages.

    Own Id: OTP-12722

  • Maps: Properly align union typed assoc values in documentation

    Own Id: OTP-12190

  • Fix spec to doc generation from erl_docgen and edoc for maps

    Own Id: OTP-12058

  • Application upgrade (appup) files are corrected for the following applications:

    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

    A new test utility for testing appup files is added to test_server. This is now used by most applications in OTP.

    (Thanks to Tobias Schlager)

    Own Id: OTP-11744

  • Handle map types in docgen_edoc_xml_cb

    Own Id: OTP-11776

  • The encoding of the notes.xml file has been changed from latin1 to utf-8 to avoid future merge problems.

    Own Id: OTP-11310

  • Correct a PDF indentation bug for tagged lists in tagged lists and added some missing tags to the DTD.

    Own Id: OTP-10725

  • Support for Unicode has been implemented.

    Own Id: OTP-10302

  • 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.

    Own Id: OTP-10630

  • Some examples overflowing the width of PDF pages have been corrected.

    Own Id: OTP-10665

  • A possibility to configure erl_docgen so it can generate documentation for other products than Erlang/OTP.

    Own Id: OTP-9040

  • A bug regarding spaces in C function prototypes has been fixed. (Thanks to Richard O'Keefe.)

    Own Id: OTP-10138

  • Some links in C libraries were not generated correctly. This bug has been fixed.

    Own Id: OTP-9832

  • Set `font-family: Courier, monospace' in OTP doc CSS

    left Courier as the primary original font and also added monospace as secondary for people which in Linux does not have it installed.

    Also adds minor cosmetic changes to the CSS. (Thanks to Ricardo Catalinas Jiménez)

    Own Id: OTP-9918

  • When generating from edoc it is now possible to use ranges in specs and <img> tags in the description.

    Own Id: OTP-9970

  • Optimize and improve handling of multiple func:s.

    Own Id: OTP-9877

  • The generation of the libraries' HTML documentation has been optimized.

    Own Id: OTP-9893

  • Bug fixes concerning the generation of manpages.

    Own Id: OTP-9614

  • Fix syntax bug in eix files.

    Own Id: OTP-9617

  • Bug fix concerning the generation of manpages.

    Own Id: OTP-9759

  • Fixed an arity calculation bug for erlang functions in the documentation index for html and pdf.

    Own Id: OTP-9772

  • 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.

    Own Id: OTP-9721

  • Bug fixes.

    Own Id: OTP-9360

  • The manpage generation has been improved.

    Own Id: OTP-9541 Aux Id: OTP-9550

  • Fix eix file generation for new function spec references.

    Own Id: OTP-9562

  • The function signatures in the pdf files was not in a fixed font.

    Own Id: OTP-9563

  • 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.

    Own Id: OTP-9576

  • The indentation after Warning: and Note: in manpages has been improved.

    Own Id: OTP-9588

  • The support for using Erlang specifications and types has been improved.

    Own Id: OTP-9261

  • Subsections below level 2 where not handled correct when generating html and pdf.

    Own Id: OTP-90730

  • Fix format_man_pages so it handles all man sections and remove warnings/errors in various man pages.

    Own Id: OTP-8600

  • 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.

    Own Id: OTP-8720

  • Fixed the transformation from xml to html of the funcs block in comref pages.

    Own Id: OTP-8792

  • The text within code examples (CODE and PRE tags) will not be space normalized for man pages.

    Own Id: OTP-8476

  • 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 .

    Own Id: OTP-8308

  • 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.

    - The arity calculation is updated.

    - 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".

    - Enhanced the menu positioning in the html documentation when a new page is loaded.

    - A number of corrections in the generation of man pages (thanks to Sergei Golovan)

    - The legal notice is taken from the xml book file so OTP's build process can be used for non OTP applications.

    Own Id: OTP-8343

This is the first release of erl_docgen for internal use.

Copyright © 2004-2022 Ericsson AB. All Rights Reserved.