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.

Sign up for GitHub

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

Jump to bottom

Fix Doxygen warnings for undocumented C++ code #6221

Open
calcmogul opened this issue Jan 13, 2024 · 2 comments · May be fixed by #6608
Open

Fix Doxygen warnings for undocumented C++ code #6221

calcmogul opened this issue Jan 13, 2024 · 2 comments · May be fixed by #6608
Labels
type: chore Formatting, reorganizing, and other necessary (but less impactful) tasks. type: docs Related to documentation and information.

Comments

@calcmogul
Copy link
Member

calcmogul commented Jan 13, 2024 •
edited

We recently went through the effort to fix (or suppress in the case of the HAL) all of JavaDoc 17's warnings for undocumented Java code (#6220). We should do the same for C++.

The following flags in the doxygen block of docs/build.gradle should be set to true:

    warnings false
    warn_if_undocumented false
@calcmogul calcmogul added type: docs Related to documentation and information. type: chore Formatting, reorganizing, and other necessary (but less impactful) tasks. labels Jan 13, 2024
Superbro525Alt added a commit to Superbro525Alt/allwpilib that referenced this issue Jan 14, 2024
@Superbro525Alt
Fixed wpilibsuite#6221
7f70252
@Superbro525Alt Superbro525Alt mentioned this issue Jan 14, 2024
Closed
@spacey-sooty
Copy link
Contributor

spacey-sooty commented Jan 23, 2024 •
edited

Should we resolve warnings in third party utils?
A large amount of the warnings appear to be from third party libraries

@calcmogul
Copy link
Member Author

We should suppress those.

@spacey-sooty spacey-sooty linked a pull request May 10, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: chore Formatting, reorganizing, and other necessary (but less impactful) tasks. type: docs Related to documentation and information.
Projects
None yet
Milestone
No milestone
2 participants
@calcmogul @spacey-sooty