Skip to content

updated Doxyfile, turned on warnings#390

Merged
WenMeng-NOAA merged 2 commits into
developfrom
ejh_docs
Sep 26, 2021
Merged

updated Doxyfile, turned on warnings#390
WenMeng-NOAA merged 2 commits into
developfrom
ejh_docs

Conversation

@edwardhartnett
Copy link
Copy Markdown
Contributor

Fixes #389

Updated the Doxyfile.in to most recent version, also turned on warnings in doxygen to show what remains to be documented.

@fossell fossell self-requested a review September 24, 2021 17:53
@fossell
Copy link
Copy Markdown
Contributor

fossell commented Sep 24, 2021

@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?

@WenMeng-NOAA WenMeng-NOAA added No Baseline Change No baseline of the UPP regression tests are made. enhancement New feature or request labels Sep 24, 2021
@edwardhartnett
Copy link
Copy Markdown
Contributor Author

edwardhartnett commented Sep 24, 2021

@fossell excellent question. Doxygen can be set to do one of three things:
1 - Print warnings and ignore them (the current settings).
2 - Fail at first warning.
3 - List all warnings and then fail.

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.

@fossell
Copy link
Copy Markdown
Contributor

fossell commented Sep 24, 2021

This make sense and will be a great feature, thanks for the explanation!

@fossell
Copy link
Copy Markdown
Contributor

fossell commented Sep 24, 2021

@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.

@WenMeng-NOAA WenMeng-NOAA added the Ready for Review This PR is ready for code review. label Sep 26, 2021
@WenMeng-NOAA WenMeng-NOAA merged commit cdfe99e into develop Sep 26, 2021
@edwardhartnett edwardhartnett deleted the ejh_docs branch September 26, 2021 13:41
EricJames-NOAA pushed a commit to EricJames-NOAA/UPP that referenced this pull request Dec 14, 2022
Fix to run workflow tasks on the WCOSS dell and cray
EricJames-NOAA pushed a commit to EricJames-NOAA/UPP that referenced this pull request Dec 14, 2022
…". (NOAA-EMC#390)

Update post process to deal with sub-hour forecast files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request No Baseline Change No baseline of the UPP regression tests are made. Ready for Review This PR is ready for code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Doxyfile.in, turn on warnings

3 participants