ocamldoc and functor arguments #2486

vicuna · 2004-04-21T15:14:44Z

Original bug ID: 2486
Reporter: administrator
Status: closed
Resolution: fixed
Priority: normal
Severity: minor
Category: ~DO NOT USE (was: OCaml general)

Bug description

Full_Name: Virgile Prevosto
Version: 3.07+2
OS: Linux (Debian 3.0)
Submission from: mpiat2314.ag2.mpi-sb.mpg.de (139.19.20.103)

Hi,
ocamldoc seems to have problems with functors whose arguments have type
constraints, as in the example below:

module type A = sig type t val foo: string end
module B =
functor (A1: A with type t = string) ->
struct let foo1 = A1.foo end

The generated documentation for B is (with ocamldoc -html)

module B: functor (A1 : sig end) -> sig end

Parameters:
A1 : sig end

val foo1 : string

It would be better to have "Parameters A1: A" (or even better to keep also the
type constraint).

vicuna · 2004-04-23T08:03:26Z

Comment author: administrator

Hello,

This is alerady fixed in the current CVS: the generated documentation in Latex
and HTML is more consistent with the original code. In your example uou will
have:
module type A = sig .. end

module B:
functor (A1 : A with type t = string) -> sig .. end

with (hopefully correct) links to modules and module types.

Thanks for your report.

Friendly,

Maxence

vicuna · 2004-04-23T08:03:43Z

Comment author: administrator

MGU - fixed

vicuna closed this as completed Apr 23, 2004

vicuna added the bug label Mar 19, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ocamldoc and functor arguments #2486

ocamldoc and functor arguments #2486

vicuna commented Apr 21, 2004

vicuna commented Apr 23, 2004

vicuna commented Apr 23, 2004

ocamldoc and functor arguments #2486

ocamldoc and functor arguments #2486

Comments

vicuna commented Apr 21, 2004

Bug description

Hi, ocamldoc seems to have problems with functors whose arguments have type constraints, as in the example below:

module type A = sig type t val foo: string end module B = functor (A1: A with type t = string) -> struct let foo1 = A1.foo end

vicuna commented Apr 23, 2004

vicuna commented Apr 23, 2004

Hi,
ocamldoc seems to have problems with functors whose arguments have type
constraints, as in the example below:

module type A = sig type t val foo: string end
module B =
functor (A1: A with type t = string) ->
struct let foo1 = A1.foo end