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

Build System: Update Doxygen to >=1.10.0 to fix URLs in Headlines #21106

Open
crasbe opened this issue Dec 23, 2024 · 0 comments
Open

Build System: Update Doxygen to >=1.10.0 to fix URLs in Headlines #21106

crasbe opened this issue Dec 23, 2024 · 0 comments

Comments

@crasbe
Copy link
Contributor

crasbe commented Dec 23, 2024

Description

While updating the LOSTANDFOUND.md file, I noticed that the headlines are not correctly formatted. After some (a lot) of searching I found out that this is a Doxygen bug ( doxygen/doxygen#10466 ) which has been fixed in version >=1.10.0 ( doxygen/doxygen#10466 (comment) ).

I'm not sure if that was a regression introduced to Doxygen at some point or if it never looked right (which I doubt).
Perhaps something in the RIOT documentation will break when updating Doxygen. For testing, I installed the lastest 1.12.0 and it complained about some configuration options being deprecrated. However my Doxygen knowledge is quite limited, so this might have some side effects or additional effort attached to it.

Current Behavior

This is a screenshot taken from https://doc.riot-os.org/md_LOSTANDFOUND.html

Screenshot 2024-12-23 215838

Expected Behaviour

This was rendered on my machine with Doxygen 1.12.0:

Screenshot 2024-12-23 215858

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