On Thu, Jun 16, 2005 at 02:59:58 +0200, Julien Cristau wrote:

> groff interprets sequences beginning with a backslash, so real
> backslashes need to be escaped. (There might be other substitutions
> needed, but I don't know enough groff to do a complete fix)

I think there is another problem with odoc_man. When a comment contains
something like "part1 [part2]. part3" in ocaml, it's translated to:
part1
.B part2
. part3

As a dot as the first character of a line is a special character, part3
doesn't show up at all in the manpage. Unfortunately I don't really know
how to fix this.
Here is an example showing the problem, from the standard ocaml
distribution (stdlib/lexing.mli):
val from_function : (string -> int -> int) -> lexbuf
(** Create a lexer buffer with the given function as its reading method.
   When the scanner needs more characters, it will call the given
   function, giving it a character string [s] and a character
   count [n]. The function should put [n] characters or less in [s],
   starting at character number 0, and return the number of characters
   provided. A return value of 0 means end of input. *)

This becomes in ocamldoc/stdlib_man/Lexing.3o:
Create a lexer buffer with the given function as its reading method.
When the scanner needs more characters, it will call the given
function, giving it a character string 
.B s
and a character
count 
.B n
. The function should put 
.B n
characters or less in 
.B s
,
starting at character number 0, and return the number of characters
provided. A return value of 0 means end of input.

The words "The function should put" don't appear in the manpage.

Thanks,
Julien Cristau

Attachment: signature.asc
Description: Digital signature

Reply via email to