You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This setting, when turned on, cause the documentation build to error out of there are any warnings.
Once existing warnings are cleared, this can be turned on, and a doxygen build added to the CI. After that, no PR will pass if it generates doxygen warnings. This is a great way to keep documentation working and the quality of doxygen good. Of course, it does not replace the review of documentation to ensure it makes sense. ;-)
But it is very helpful, we do it now with many NOAA repositories and it works well.
The text was updated successfully, but these errors were encountered:
Doxygen has a WARN_AS_ERROR setting.
This setting, when turned on, cause the documentation build to error out of there are any warnings.
Once existing warnings are cleared, this can be turned on, and a doxygen build added to the CI. After that, no PR will pass if it generates doxygen warnings. This is a great way to keep documentation working and the quality of doxygen good. Of course, it does not replace the review of documentation to ensure it makes sense. ;-)
But it is very helpful, we do it now with many NOAA repositories and it works well.
The text was updated successfully, but these errors were encountered: