ocaml/ocamldoc/Changes.txt

79 lines
3.4 KiB
Plaintext
Raw Normal View History

Next release :
- dumps now contain a magic number, checked when dumps are loaded
- new option -o to use with texi, latex and dot generators
- new .code CSS class used
- better output for classes and modules, with their type
- added texinfo generator, by Olivier Andrieu
- removed iso generator, which became the odoc_check custom generator
- link syntax {{:url}text} added to the manual
- (** comments in code is colorized in ocaml code html pages
- new class .code in style
- new generator : -dot . Output dot code to display
modules or types dependencies.
- new option -inv-merge-ml-mli to inverse the priority of
.ml and .mli when merging
- option -werr becomes -warn-error
- possibility to define and reference section labels
Exemple:
(** {2:mysectionlabel My title bla bla bla} *)
in module Foo
This section is referenced with {!Foo.mysectionlabel} in
a comment.
Pre-release 4 :
- new option -werr to treat ocamldoc warnings as errors
- new option -hide to remove some modules from complete names,
(e.g., print ref instead of Pervasives.ref)
- HTML doc in classic style only contain indexes to existing element kinds
(i.e. there is no class index if the doc does not contain any class.)
- First description sentence now stops at the first period followed by a blank,
or at the first blank line.
- update of user manual
- check report generator added (options -iso and -iso-{val|ty|cl|ex|mod})
- Odoc_info.Scan.scanner base class added
- support for custom tags (@xxx with xxx not a predefined tag), see manual
- new classes info in Odoc_html, Odoc_to_text, Odoc_latex, and Odoc_man, which
contains the functions for printing info structures
- replacement of modules Odoc_html.Text and Odoc_latex.Text by
classes Odoc_html.text and Odoc_latex.text to allow the redefinition
of their methods in custom generators
- bug fix : a shortcut list can be pu after a blank line
- improved display of variant constructors, record fields and
their comments in classic HTML
- blank lines in comments become <p> in HTML instead of <br>
- bug fix : there can be blanks between the last item
and the ending } of a list
- new option -latextitles
- number of errors encountered is displayed
- if at least one error occurs, exit code is not 0
- more precise error messages
- bug fix : \n and other blanks are accepted after, for example, {i
Pre-release 3 :
- option -stars
- complete paths of executables in the generated Makefile
- names of executables changed to ocamldoc and ocamldoc.opt
- better LaTeX output
- option -sepfiles for LaTeX
- ocamldoc.sty used by the generated LaTeX
- ocamldoc.hva added to use Hevea on the generated LaTeX
- user manual updated
- {[ ]} marks to put pre-formatted code on more than one line
- {!Toto.tutu} to add cross references between elements
- some bug fixes
Rep-release 2 :
- generator of texinfo files : odoc_texi.cma
- use of CSS in generated html
- new option -css-style to provide a different style sheet
- improved html
- added more precise titles in generated html pages
- no more links to unknown elements
- added indexes
- simple html : added <LINK ...> in <HEAD> : compliant
browsers should display quick access to modules and indexes in
their navigation bar (for example, mozilla 0.9.5 is compliant)
- '{bone}' doesn't work any more ; a space is required as in '{b one}'.
Same for {e, {i, and some others marks. Check the manual
- bug fixes