-
Notifications
You must be signed in to change notification settings - Fork 134
PR to add and correct doxygen docblocks to emcsfc_snow2mdl.fd/*.f #348
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
Changes from 10 commits
29fc351
83ce4a5
2fd2491
d394abd
e5afa82
342194e
f43e11a
1d2c62e
c4312a9
ae5ff63
b9512ca
81e3dcc
0266c7d
f818f94
3012407
01c51d6
09693a8
6556143
46cff79
dba8041
db0f1b8
c1f7306
e286081
a1e4500
cbcefde
b932645
1fa6597
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| !> @file | ||
| !! @brief Read in data defining the model grid. | ||
| !! | ||
| !! @author gayno org: w/np2 @date 2005-dec-16 | ||
| !!@author gayno org: w/np2 @date 2005-dec-16 | ||
| !! | ||
| !! program history log: | ||
| !! - 2005-dec-16 gayno - initial version | ||
|
|
@@ -58,57 +58,53 @@ module model_grid | |
| real, allocatable :: lsmask_mdl_sav (:,:) | ||
| real :: resol_mdl ! in km | ||
|
|
||
| contains | ||
| !> | ||
|
edwardhartnett marked this conversation as resolved.
Outdated
|
||
| !! @brief read latitude, longitude, land/sea mask on the model grid. | ||
| !! | ||
| !! @author George Gayno org: w/np2 @date 2005-dec-16 | ||
| !! | ||
| !! | ||
| !! program history log: | ||
| !! 2005-dec-16 gayno - initial version | ||
| !! 2007-nov-30 gayno - improved method for thinning gfs grids | ||
| !! added nam b-grids | ||
| !! 2014-sep-29 gayno - add option to read lat,lon and mask | ||
| !! data in grib2. | ||
| !! | ||
| !! usage: call read_mdl_grid_info | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove the entire usage line. Doxygen does this automatically. |
||
| !! | ||
| !! input argument list: n/a | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove any documentation element that says n/a or none. It is not conveying information. |
||
| !! | ||
| !! output argument list: n/a | ||
| !! | ||
| !! files: | ||
| !! inputs: | ||
| !! - model latitudes (grib 1 or grib 2) | ||
|
edwardhartnett marked this conversation as resolved.
|
||
| !! - model longitudes (grib 1 or grib 2) | ||
| !! - model landmask (grib 1 or grib 2) | ||
| !! - # pts per row, gfs grid (the "lonsperlat" file, ascii) | ||
| !! | ||
| !! outputs: none | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove lines which are just "none" |
||
| !! | ||
| !! condition codes: all fatal | ||
| !! 76 - bad open/read gfs "lonsperlat" file | ||
| !! 79 - unrecognized model grid | ||
| !! 80 - bad open model latitude file | ||
| !! 81 - bad read of model latitude grib 1 header | ||
| !! 82 - bad read of model latitude data | ||
| !! 83 - bad open model longitude file | ||
| !! 82 - bad read of model longitude data | ||
| !! 85 - bad open model landmask file | ||
| !! 86 - bad read of model landmask data | ||
| !! 90 - model latitude file not grib 1 or grib 2 | ||
| !! 91 - model longitude file not grib 1 or grib 2 | ||
| !! 92 - model landmask file not grib 1 or grib 2 | ||
| !! | ||
| !! remarks: none. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove all documentation sections which are just "none" or "N/A". |
||
| !! | ||
|
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There should not be a blank like, and the documentation block should be after "contains".
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Moved docblock to after the contains statement Added doxygen comments for snowdat.f. |
||
| contains | ||
| subroutine read_mdl_grid_info | ||
| !$$$ subprogram documentation block | ||
| ! | ||
| ! subprogram: read_mdl_grid_info | ||
| ! prgmmr: gayno org: w/np2 date: 2005-dec-16 | ||
| ! | ||
| ! abstract: read latitude, longitude, land/sea mask on the | ||
| ! model grid. | ||
| ! | ||
| ! program history log: | ||
| ! 2005-dec-16 gayno - initial version | ||
| ! 2007-nov-30 gayno - improved method for thinning gfs grids | ||
| ! added nam b-grids | ||
| ! 2014-sep-29 gayno - add option to read lat,lon and mask | ||
| ! data in grib2. | ||
| ! | ||
| ! usage: call read_mdl_grid_info | ||
| ! | ||
| ! input argument list: n/a | ||
| ! | ||
| ! output argument list: n/a | ||
| ! | ||
| ! files: | ||
| ! inputs: | ||
| ! - model latitudes (grib 1 or grib 2) | ||
| ! - model longitudes (grib 1 or grib 2) | ||
| ! - model landmask (grib 1 or grib 2) | ||
| ! - # pts per row, gfs grid (the "lonsperlat" file, ascii) | ||
| ! | ||
| ! outputs: none | ||
| ! | ||
| ! condition codes: all fatal | ||
| ! 76 - bad open/read gfs "lonsperlat" file | ||
| ! 79 - unrecognized model grid | ||
| ! 80 - bad open model latitude file | ||
| ! 81 - bad read of model latitude grib 1 header | ||
| ! 82 - bad read of model latitude data | ||
| ! 83 - bad open model longitude file | ||
| ! 82 - bad read of model longitude data | ||
| ! 85 - bad open model landmask file | ||
| ! 86 - bad read of model landmask data | ||
| ! 90 - model latitude file not grib 1 or grib 2 | ||
| ! 91 - model longitude file not grib 1 or grib 2 | ||
| ! 92 - model landmask file not grib 1 or grib 2 | ||
| ! | ||
| ! remarks: none. | ||
| ! | ||
| !$$$ | ||
|
|
||
| use grib_mod ! grib 2 library | ||
|
|
||
| implicit none | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blank space before author tag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blank space before author tag.