Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0006257OCamlOCamldocpublic2013-12-02 06:032013-12-09 09:42
Reporterygrek 
Assigned Toguesdon 
PrioritynormalSeverityminorReproducibilityalways
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version4.00.1 
Target VersionFixed in Version 
Summary0006257: hides ocamldoc comments on variant constructors
DescriptionThis is frustrating because usual comments are not hidden, while recognized tags are completely omitted from generated html.
Steps To Reproduce$ cat q.ml
(** some module *)
type t =
| A
| B (** @since v2 *)
| C (** since some time ago *)

$ ocamldoc -html q.ml -d html/

$ html2text html/Q.html
****** Module Q ******
module Q: sig .. end
some module
===============================================================================
type t =
| A
| B
| C (* since some time ago *)
TagsNo tags attached.
Attached Files

- Relationships

-  Notes
(0010688)
guesdon (manager)
2013-12-03 13:33

To be sure I understand the problem, in your example, you would like to get:

****** Module Q ******
module Q: sig .. end
some module
===============================================================================
type t =
| A
| B (* Since v2 *)
| C (* since some time ago *)

Is that right ?
(0010699)
ygrek (reporter)
2013-12-09 03:07

Yes, that would be perfect
(0010700)
guesdon (manager)
2013-12-09 09:42

This is implemented in revision 14343 in trunk (and Changes file is updated is revision 14344).

The same is done for record fields.

Please not that this changes the type of:
- Odoc_info.Type.variant_constructor, field ty_text (now of type "info option")
- Odoc_info.Type.record_field, field rf_text (now of type "info option").

This may break some custom ocamldoc generators.

- Issue History
Date Modified Username Field Change
2013-12-02 06:03 ygrek New Issue
2013-12-02 06:03 ygrek Status new => assigned
2013-12-02 06:03 ygrek Assigned To => guesdon
2013-12-03 13:33 guesdon Note Added: 0010688
2013-12-09 03:07 ygrek Note Added: 0010699
2013-12-09 09:42 guesdon Note Added: 0010700
2013-12-09 09:42 guesdon Status assigned => resolved
2013-12-09 09:42 guesdon Resolution open => fixed
2013-12-09 09:42 guesdon Steps to Reproduce Updated View Revisions


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker