allwpilib icon indicating copy to clipboard operation
allwpilib copied to clipboard

Fix Doxygen warnings for undocumented C++ code

Open calcmogul opened this issue 7 months ago • 2 comments

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 (https://github.com/wpilibsuite/allwpilib/pull/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 avatar Jan 13 '24 23:01 calcmogul

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

spacey-sooty avatar Jan 23 '24 07:01 spacey-sooty

We should suppress those.

calcmogul avatar Jan 23 '24 16:01 calcmogul