Skip to content

Feature request: emit warnings for broken references #844

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

Closed
anarthal opened this issue Jan 31, 2025 · 2 comments
Closed

Feature request: emit warnings for broken references #844

anarthal opened this issue Jan 31, 2025 · 2 comments

Comments

@anarthal
Copy link

When a \ref command is used and the target can't be found, I'd like to know, as this usually implies a mistake on my side. Doxygen emits such warnings.

@alandefreitas
Copy link
Collaborator

We had a warning, but the problem is it was warning too much because @ref some-excluded-or-external-symbol is also valid and should be converted to simple inline code or a link to a tagfile symbol. I guess we can restore that and make it an option.

@anarthal
Copy link
Author

Hm, if there is a match in a tagfile, there should be no warning IMO. A link to an excluded symbol should be a warning I'd say - it's a broken link at the end of the day.

alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Feb 1, 2025
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