You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Original bug ID: 2589 Reporter: administrator Status: closed Resolution: fixed Priority: normal Severity: minor Category: ~DO NOT USE (was: OCaml general)
It seems to me that the problem comes from the fact that ocamldoc doesn't
differentiate (at least at the level of generated file) module type names from
module names. For example if I have the following file
---test.mli---
module type B = sig (** B type doc ) end
module B : sig (* B module doc *) end
And that I generate its html documentation. Then if I click on the link for the
documentation of module B, I get on the documentation of the module type B
which is not the expected linkage. The documentation for the B module is not
generated at all or maybe gets overwritten by the documentation for the module
type.
Regards,
Daniel
The text was updated successfully, but these errors were encountered:
It seems to me that the problem comes from the fact that ocamldoc doesn't
differentiate (at least at the level of generated file) module type names from
module names. For example if I have the following file
---test.mli---
module type B = sig (** B type doc ) end
module B : sig (* B module doc *) end
And that I generate its html documentation. Then if I click on the link for
the documentation of module B, I get on the documentation of the module type
B which is not the expected linkage. The documentation for the B module is not
generated at all or maybe gets overwritten by the documentation for the module
type.
... if you check section 15.1.3 of the Objective Caml manual (Coding rules for
ocamldoc), you can read that:
"In a module, there must not be two modules, two module types or a module and a
module type with the same name."
Indeed, the html file for the module type Foo.A is the same as the html file for
the module Foo.A.
Original bug ID: 2589
Reporter: administrator
Status: closed
Resolution: fixed
Priority: normal
Severity: minor
Category: ~DO NOT USE (was: OCaml general)
Bug description
Full_Name: Daniel Buenzli
Version: 3.07+2
OS: macos 10.3.3
Submission from: lamp2priv1.epfl.ch (128.178.154.46)
Dear bugtracker,
The following valid mli file makes ocamldoc.opt segfault
---test.mli---
module type A = sig end
module A : A
It seems to me that the problem comes from the fact that ocamldoc doesn't
differentiate (at least at the level of generated file) module type names from
module names. For example if I have the following file
---test.mli---
module type B = sig (** B type doc ) end
module B : sig (* B module doc *) end
And that I generate its html documentation. Then if I click on the link for the
documentation of module B, I get on the documentation of the module type B
which is not the expected linkage. The documentation for the B module is not
generated at all or maybe gets overwritten by the documentation for the module
type.
Regards,
Daniel
The text was updated successfully, but these errors were encountered: