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

Documentation may be off by one in some cases #18

Open
jschwe opened this issue Aug 26, 2024 · 0 comments
Open

Documentation may be off by one in some cases #18

jschwe opened this issue Aug 26, 2024 · 0 comments

Comments

@jschwe
Copy link
Collaborator

jschwe commented Aug 26, 2024

In enums or structs where the doxygen comment is like

the_thing, /// < Documentation for the_thing
something_else, /// < Documentation for something_else

bindgen will put the documentation meant for the_thing on something_else, since it doesn't know about the meaning of the < character, resulting in wrong documentation.

Source code using /**< */ style comments seems to not suffer this problem:

the_thing,  /**<  Documentation for the_thing (works properly)  */
...
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