Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hides ocamldoc comments on variant constructors #6257

Closed
vicuna opened this issue Dec 2, 2013 · 3 comments

Comments

Projects
None yet
1 participant
@vicuna
Copy link

commented Dec 2, 2013

Original bug ID: 6257
Reporter: @ygrek
Assigned to: @zoggy
Status: closed (set by @xavierleroy on 2015-12-11T18:25:27Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.00.1
Category: ocamldoc
Monitored by: @gasche @hcarty @yakobowski

Bug description

This 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 *)

@vicuna

This comment has been minimized.

Copy link
Author

commented Dec 3, 2013

Comment author: @zoggy

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 ?

@vicuna

This comment has been minimized.

Copy link
Author

commented Dec 9, 2013

Comment author: @ygrek

Yes, that would be perfect

@vicuna

This comment has been minimized.

Copy link
Author

commented Dec 9, 2013

Comment author: @zoggy

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.

@vicuna vicuna closed this Dec 11, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.