-
Notifications
You must be signed in to change notification settings - Fork 104
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
updated Doxyfile, turned on warnings #390
Conversation
@edwardhartnett - thanks for demonstrating the warn as error feature. This can be a handy check to ensure new code is well documented by developers. One question, does the workflow abort after the first instance of undocumented routine? Or will it indicate all undocumented routines? Specifically for example in this PRs failed checks, is AVIATION the only file with undocumented subroutine? |
@fossell excellent question. Doxygen can be set to do one of three things: After current PRs are merged, we will be in state 1. Doxygen warnings will be in the CI output, but will not cause the build to fail, so CI will still passs. I have entered another issue (#392) which lists all the current warnings. Once these are fixed, we can turn on checking for new code, which is very worthwhile. Once we are checking new code, we can fail on first error or fail after all errors. |
This make sense and will be a great feature, thanks for the explanation! |
@WenMeng-NOAA - This is just an update to the Doxygen file and has no code changes. I approve and it can merged as your discretion. |
Fix to run workflow tasks on the WCOSS dell and cray
…". (NOAA-EMC#390) Update post process to deal with sub-hour forecast files.
Fixes #389
Updated the Doxyfile.in to most recent version, also turned on warnings in doxygen to show what remains to be documented.