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

Generate Haddock from C-style comments #200

Open
FintanH opened this issue Jun 12, 2018 · 1 comment
Open

Generate Haddock from C-style comments #200

FintanH opened this issue Jun 12, 2018 · 1 comment

Comments

@FintanH
Copy link
Contributor

FintanH commented Jun 12, 2018

I was mulling over protobuf documentation. I thought it would be nice if the C-style comments could turn into Haddock documentation for messages and possibly their fields. I dunno how possible this is though.

@judah
Copy link
Collaborator

judah commented Jun 13, 2018

This ought to be possible in principle. The descriptor proto message that we get from protoc has the comments attached to individual entities via SourceCodeInfo:
https://github.com/google/protobuf/blob/b40cb4bc8bd233330cba2ab09d6e3016b004dce0/src/google/protobuf/descriptor.proto#L728
Seems like we could parse them out into Haddocks, possibly escaping any special Haddock characters.

blackgnezdo added a commit that referenced this issue Aug 17, 2018
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

2 participants