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

Fix all Doxygen warnings #1040

Merged
merged 14 commits into from
Dec 18, 2024
Merged

Fix all Doxygen warnings #1040

merged 14 commits into from
Dec 18, 2024

Conversation

azrogers
Copy link
Contributor

@azrogers azrogers commented Dec 11, 2024

This PR fixes every remaining Doxygen warning, and configures Doxygen to return a non-zero exit code when there's a warning, meaning the CI task will fail if code is added that causes new warnings. This not only helps improve our current documentation, but will allow us to keep a better eye on our documentation going forward!

Original description:

This PR adds Doxygen documentation to a whole lot of things. How many things? I can't quite say, but the current CI Doxygen log is 5052 lines long while the CI Doxygen log for this PR is only 2991 lines long - so quite a few warnings have been taken care of. Plenty still remain (651, by my count of just the STDERR log), but this is still a pretty big step forward.

@azrogers azrogers marked this pull request as draft December 11, 2024 23:51
@azrogers
Copy link
Contributor Author

@kring pointed out that the ideal here is that we get Doxygen warnings to zero, so we can then start treating them as errors which will help make sure we keep the docs up to date going forward. I think that's an achievable goal, so I'm making this PR a draft for the moment while I work on that.

Base automatically changed from update-ext-structural-metadata to main December 12, 2024 03:18
@azrogers azrogers changed the title Document even more things! Fix all Doxygen warnings Dec 17, 2024
@azrogers azrogers marked this pull request as ready for review December 17, 2024 18:46
@azrogers
Copy link
Contributor Author

And with that, every remaining warning has been resolved!

@kring
Copy link
Member

kring commented Dec 18, 2024

This is great, thanks @azrogers!

@kring kring merged commit 9a95ae6 into main Dec 18, 2024
22 checks passed
@kring kring deleted the doxygen-coverage branch December 18, 2024 09:46
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

Successfully merging this pull request may close these issues.

2 participants