Conversation
pheki
left a comment
There was a problem hiding this comment.
Great work!
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.
Yep, you should commit them, CI will check if they're correct. For now CI only commits generated bindings when creating or updating the "Update bindings" PR.
Can you add a new version to the changelog? Something like
## [0.3.4] - Unreleased
### Added
- Doc comments are now also copied from vitasdk (#30).
|
I made a PR to |
|
It seems that your last commit adds comments for deprecated fields, such as: And those are good, but they're not getting generated on my end... Do you know why? |
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::transformpanics 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.