Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0007488OCamlocamldocpublic2017-02-18 18:412017-02-19 09:23
Reporterxleroy 
Assigned Tooctachron 
PriorityhighSeverityminorReproducibilityalways
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version4.05.0 +dev/beta1/beta2/beta3/rc1 
Target VersionFixed in Version4.05.0 +dev/beta1/beta2/beta3/rc1 
Summary0007488: Wrong Latex output for variant types
DescriptionConsider the following type declaration in a .mli file:

type t =
  | A (** This is case A *)
  | B (** This is the other case, B *)

ocamldoc -latex produces:

\label{type:Foo.t}\begin{ocamldoccode}
type t =
\end{ocamldoccode}
  | A\begin{ocamldoccomment}
This is case A


\end{ocamldoccomment}
  | B\begin{ocamldoccomment}
This is the other case, B


\end{ocamldoccomment}


Notice that "| A" and "| B" are outside the ocamldoccode environment, causing LaTeX to render them incorrectly.

(Edited from original report) The problem doesn't happen consistently. For example, running ocamldoc on unix.mli from the 4.05 working sources, the "process_status" type is correctly formatted.
(End edit.)

There are many instances of this problem in the PDF manual for the working sources (4.05-dev), so if it could be solved by the 4.05 release this would be great.


TagsNo tags attached.
Attached Files

- Relationships

-  Notes
(0017337)
octachron (developer)
2017-02-18 20:32

I can reproduce (and fix) the first failing case, but I am bit worried that I cannot reproduce the second counter-example: the latex output is still incorrect when I look at the generated latex code?
(0017339)
octachron (developer)
2017-02-18 22:32

A possible fix is proposed here: https://github.com/ocaml/ocaml/pull/1053. [^]
(0017340)
gasche (developer)
2017-02-19 01:36

Fixed using Octachron's patch.
(0017341)
xleroy (administrator)
2017-02-19 09:23

Thanks for the super-fast reply!

The second part of my report (about comments on their own lines) was completely wrong. I edited it for the record.

- Issue History
Date Modified Username Field Change
2017-02-18 18:41 xleroy New Issue
2017-02-18 20:21 octachron Assigned To => octachron
2017-02-18 20:21 octachron Status new => assigned
2017-02-18 20:32 octachron Note Added: 0017337
2017-02-18 22:32 octachron Note Added: 0017339
2017-02-19 01:36 gasche Note Added: 0017340
2017-02-19 01:36 gasche Status assigned => resolved
2017-02-19 01:36 gasche Fixed in Version => 4.05.0 +dev/beta1/beta2/beta3/rc1
2017-02-19 01:36 gasche Resolution open => fixed
2017-02-19 09:23 xleroy Note Added: 0017341
2017-02-19 09:23 xleroy Description Updated View Revisions
2017-02-23 16:46 doligez Category OCamldoc => ocamldoc


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker