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

Add #[cfg(doc)] guarded imports to fix intra-doc links #71

Open
jschwe opened this issue Jan 11, 2025 · 0 comments
Open

Add #[cfg(doc)] guarded imports to fix intra-doc links #71

jschwe opened this issue Jan 11, 2025 · 0 comments

Comments

@jschwe
Copy link
Collaborator

jschwe commented Jan 11, 2025

The doxygen documentation always refers to the types by name, but since we generate things into different files and even crates, we need to add corresponding imports so that rustdoc can do its job properly.

How to investigate:

Generate the documentation and investigate the warnings regarding unresolved intra doc links:

cargo doc --all-features
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