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.

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

Doxygen for CALDWP.f #423

Merged
merged 2 commits into from
Dec 23, 2021
Merged

Conversation

kayeekayee
Copy link
Contributor

This is part of Issue #392
Fixes the doxygen warnings in CALDWP.f

@WenMeng-NOAA
Copy link
Collaborator

@BoCui-NOAA @JesseMeng-NOAA Please be warn of tweaking for Doxygen format.

@WenMeng-NOAA
Copy link
Collaborator

@kayeekayee Thanks for working on this.

@WenMeng-NOAA WenMeng-NOAA added documentation Improvements or additions to documentation No Baseline Change No baseline of the UPP regression tests are made. Ready for Review This PR is ready for code review. labels Dec 22, 2021
!> @param[in] T1D - Temperature (K)
!> @param[out] TDWP - Dewpoint temperature (K)
!>
!> Program history
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have been making these into tables instead of lists, and it looks nice. So something like this:

!> ### Program History Log
!> Date | Programmer | Comments
!> -----|------------|---------
!> 2003-06-06 | Gilbert | Initial
!> 2008-05-14 | Vuong | Added the option -m0 (No explicit missing values included within the datavalues, modified the options and help messages
!> 2010-12-02 | Vuong | Changed Master Table Version Number from 2 to 6. Add option -mastertable_ver_x where x is mater table version 2 to 10 

You may choose to do the same, or keep on making it a list. The UPP team should get together and decide...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kayeekayee - I just looked at an example in NCEPLIBS and it looks quite nice as a table, much more readable. I recommend we do the same for UPP. Thanks for the suggestion @edwardhartnett.

@kayeekayee kayeekayee merged commit 7e9b6eb into NOAA-EMC:develop Dec 23, 2021
@kayeekayee kayeekayee deleted the doxygen_CALDWP branch March 14, 2022 19:13
EricJames-NOAA pushed a commit to EricJames-NOAA/UPP that referenced this pull request Dec 14, 2022
* Changes for using netcdf diag in GSI and EnKF

* Correct diag name for dbz

* Fix the diag files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 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.

None yet

4 participants