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 Doxygen warnings for C++ code #6608

Merged
merged 10 commits into from
Aug 21, 2024

Conversation

spacey-sooty
Copy link
Contributor

Resolves #6221

@spacey-sooty spacey-sooty force-pushed the doxygenfix branch 3 times, most recently from 78a11e3 to 9421382 Compare May 11, 2024 16:01
@calcmogul
Copy link
Member

calcmogul commented May 11, 2024

I think Doxygen is failing to parse requires clauses. Here's how I worked around them in Sleipnir:

// FIXME: Doxygen gives internal inconsistency errors:
//   scope for class sleipnir::fmt::formatter< Derived, CharT > not found!
//   scope for class sleipnir::fmt::formatter< sleipnir::Variable > not found!
//   scope for class sleipnir::fmt::formatter< T > not found!

//! @cond Doxygen_Suppress

Badly parsed code here

//! @endcond

@sciencewhiz
Copy link
Contributor

It looks like the latest Doxygen (1.10.0) has a fix for parsing requires

@spacey-sooty
Copy link
Contributor Author

If so that would probably be a good reason to upgrade. Might also fix the parsing bugs for other parts. I'll have a go fixing the warning around WPIWarnings.mac and WPIErrors.mac without a supression and wait for the WPILib mirror of Doxygen releases to have latest Doxygen before trying to fix everything else.

@spacey-sooty spacey-sooty marked this pull request as ready for review August 16, 2024 01:33
@spacey-sooty spacey-sooty requested review from PeterJohnson and a team as code owners August 16, 2024 01:33
@PeterJohnson PeterJohnson merged commit a9ce329 into wpilibsuite:main Aug 21, 2024
33 checks passed
@spacey-sooty spacey-sooty deleted the doxygenfix branch August 22, 2024 02:53
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.

Fix Doxygen warnings for undocumented C++ code
4 participants