Fix doxygen in AVIATION.f#395
Merged
Merged
Conversation
Collaborator
|
@fossell Would you please review the PR? Thanks! |
fossell
approved these changes
Sep 29, 2021
Contributor
|
@edwardhartnett - Thanks for providing this an example of porting to doxygen syntax and standards. We will use this as guidance to translate other routines as well. @WenMeng-NOAA - This PR is just comment changes that Ed has provided as an example for doxygen. I have not tested this PR, just visually inspected. Only comments were changed in the routine, but if you want to run RTs to ensure no issues that's ok, either way is fine with me. |
Collaborator
|
@edwardhartnett Could you sync your branch with upstream/develop? Thanks! |
WenMeng-NOAA
added
Ready for Review
Contributor
Author
|
@WenMeng-NOAA I have synced branch... |
Collaborator
|
@edwardhartnett Do you have an UPP issue linking to this PR? |
WenMeng-NOAA
approved these changes
Oct 5, 2021
Contributor
Author
|
@WenMeng-NOAA this relates to issue #392. |
Collaborator
EricJames-NOAA
pushed a commit
to EricJames-NOAA/UPP
that referenced
this pull request
Dec 14, 2022
…uld be the same as FV3_HRRR except for DT_ATMOS, dt_inner, and imfdeepcnv. (NOAA-EMC#395) This update also avoids some NA 13km FV3 crashes. Contributions from Tanya/Joe/Ming.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #392
In this PR I fix the doxygen in the file AVIATION.f, to eliminate doxygen warnings for that file.
I cannot fix all your legacy documentation - this is just a sample to show how it should be done. ;-)
Some things to note for doxygen conversion:
In general, punctuation is missing from much of the documentation. Fortran programmers apparently are trying to save on keystrokes by refraining from putting a period on the end of the sentences. ;-) That's not good. Documentation should be punctuated properly to aid understanding.