Fixing some doxygen documentation - first pass #918
Conversation
doxygenated module_wrt_grid_comp.F90
turn on more doxygen warnings
more doxygen
Doxygenate fv_moving_nest_types.F90 and fv_moving_nest_physics
Moving doxygen changes from old PR to ejh_doxygen branch
edwardhartnett
changed the title
Complete doxygen for moving_nest subdirectory
Doxygen for cpl subdirectory
Update fv3_cap.F90
| @@ -1,3 +1,6 @@ | |||
| !> @file | |||
| !> @brief ??? | |||
There was a problem hiding this comment.
@rmontuoro can you please fill in what all the "???" documentation should be in this file? According to github, you originally added this file.
|
|
||
| !> ??? | ||
| !> | ||
| !> @param[in] gcomp ??? |
There was a problem hiding this comment.
@junwang-noaa can you please tell us what the ??? should be in this documentation?
| integer, public :: nvar_before_lake = 0 | ||
|
|
||
| ! The lsoil flag is only meaningful when reading:; | ||
| integer, public :: nvar2o = 0 !< ??? |
There was a problem hiding this comment.
@SamuelTrahanNOAA can you please tell us what the ??? in this documentation should be?
| @@ -64,7 +70,12 @@ subroutine fill_bbox_r4_2d(out_bbox, in_grid) | |||
| out_bbox%je = ubound(in_grid, 2) | |||
| end subroutine fill_bbox_r4_2d | |||
|
|
|||
|
|
|||
| !> ??? | |||
There was a problem hiding this comment.
@wramstrom can you please tell us what should replace the ??? in this documentation?
| real(kind=kind_phys), dimension(:,:,:), allocatable, save :: smc | ||
| real(kind=kind_phys), dimension(:,:,:), allocatable, save :: stc | ||
| real(kind=kind_phys), dimension(:,:,:), allocatable, save :: slc | ||
| real(kind=kind_phys), dimension(:,:), allocatable, save :: xlat !< ??? |
There was a problem hiding this comment.
@climbfuji can you tell us what should replace the ??? in this documentation?
There was a problem hiding this comment.
I would check GFS_typedefs.F90/GFS_typedefs.meta for the variable with the same name
Description
Fixing some doxygen documentation
Issue(s) addressed
Link the issues to be closed with this PR, whether in this repository, or in another repository.
(Remember, issues should always be created before starting work on a PR branch!)
Testing
How were these changes tested?
What compilers / HPCs was it tested with?
Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
Have the ufs-weather-model regression test been run? On what platform?
Dependencies
If testing this branch requires non-default branches in other repositories, list them.
Those branches should have matching names (ideally)