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 C++ code docs #85

Merged
merged 7 commits into from
Sep 16, 2021
Merged

Conversation

gregtatum
Copy link
Collaborator

My editor will present documentation as tooltips when I hover C++ classes. It would be nice for the documentation to be propagated to the header files. This PR does that. Each commit should be well-formed for review. I did include one drive-by with some comments I wrote as I was getting oriented in the code.

Copy link
Contributor

@Manishearth Manishearth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add some docs to example/ too? Not everywhere, just enough for the end-to-end test

@Manishearth
Copy link
Contributor

Oh, we already have those, you just need to regen it to make CI pass.

@gregtatum
Copy link
Collaborator Author

Ah yes, I re-generated the examples, and caught a bug in the generated docs too.

@Manishearth Manishearth merged commit fb943bf into rust-diplomat:main Sep 16, 2021
@Manishearth
Copy link
Contributor

Thanks!

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

Successfully merging this pull request may close these issues.

2 participants