Enabled comments in bindgen and added doxygen pre-processor #30
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Implementation
Luckily, comments in the headers mostly follow Doxygen formatting. doxygen-rs crate does exactly what we need and converts them to rustdoc format.
Without additional pre-processing,
doxygen_rs::transform
panics due to some mistakes and unexpected things in the comments, thus the callback first fixes them.After the transformation, some of the prefixes used for field comments in headers are stripped away, e.g. this
I've also committed the generated bindings, although I'm not sure what our workflow is with them (as in should they be updated solely by gh actions, or is committing them ok?). Anyway, the committed bindings show how the comments look like with these changes.