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

@-tags include everything after them #1138

Open
lpw25 opened this issue May 31, 2024 · 0 comments
Open

@-tags include everything after them #1138

lpw25 opened this issue May 31, 2024 · 0 comments

Comments

@lpw25
Copy link
Contributor

lpw25 commented May 31, 2024

I'm pretty sure I implemented this behaviour once upon a time and I did so to match ocamldoc's existing behaviour. But I wonder if it is a mistake to have @tags extend onwards until either the end of the comment or another @tag. I just found something like:

(** Some docs about things

     @param foo Stuff about a parameter
     
     More stuff about the whole function, not just the parameter. *)

and it seems a very reasonable thing to write, but it gets rendered very badly because everything after @param is considered part of the tag. (Also #329 is right, the markup for tags is bad).

Perhaps we should take a blank line as ending the tag? I think the actual tags we support would be fine only taking a single paragraph as input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant