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

CLI integration with doxygen-rs? #2953

Open
kornelski opened this issue Oct 16, 2024 · 1 comment
Open

CLI integration with doxygen-rs? #2953

kornelski opened this issue Oct 16, 2024 · 1 comment

Comments

@kornelski
Copy link
Contributor

kornelski commented Oct 16, 2024

Doxygen seems to be commonly used in C/C++ projects, and its annotations look pretty messy in Rustdoc.

bindgen chose to offload processing of Doxygen annotations to doxygen-rs. The problem is that the process_comment callback used as an integration point exists only in the bindgen's Rust API.

In my crates, I generally avoid using bindgen at build time, and have workflows based around running bindgen-cli instead. Having to replace shell one-liners with Rust programs is inconvenient.

Could bindgen-cli have some way of supporting doxygen annotations?

Add doxygen-rs as an optional Cargo feature? Or if you want bindgen to remain completely agnostic, maybe support filtering of comments by through stdin/stdout of a command? (so that doxygen-rs could provide an executable for this)

@pvdrz
Copy link
Contributor

pvdrz commented Oct 17, 2024

This might be relevant: #2949 (comment)

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