doxygen documentation: 6th subset#841
Conversation
JessicaMeixner-NOAA
left a comment
There was a problem hiding this comment.
********************* non-identical cases ****************************
mww3_test_03/./work_PR2_UNO_MPI_d2 (12 files differ)
mww3_test_03/./work_PR1_MPI_d2 (15 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c (14 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2_c (15 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2 (16 files differ)
mww3_test_03/./work_PR2_UQ_MPI_d2 (15 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2 (15 files differ)
ww3_ta1/./work_UPD0F_U (0 files differ)
ww3_tp2.10/./work_MPI_OMPH (7 files differ)
ww3_tp2.16/./work_MPI_OMPH (4 files differ)
ww3_tp2.17/./work_a (1 files differ)
ww3_tp2.17/./work_c (1 files differ)
ww3_tp2.17/./work_b (1 files differ)
ww3_tp2.6/./work_ST0 (1 files differ)
ww3_tp2.6/./work_ST4 (1 files differ)
ww3_tp2.6/./work_pdlib (1 files differ)
ww3_ufs1.3/./work_a (1 files differ)
Pull Request Summary
Adds another (6th) subset of
doxygenmarked source files.Description
Provide a detailed description of what this PR does.
Adds
doxygendocumentation for the following files:ww3_systrk.F90ww3_outp.F90ww3_outf.F90ww3_gspl.F90w3updtmd.F90w3triamd.F90w3srcemd.F90w3src6md.F90w3src4md.F90w3src3md.F90Note: the files
wmesmfmd.F90andw3uostmd.F90have also been marked up, though for whatever reasonnot all of the subroutines/functions are appearing in the doxygen documentation. This is the second time I've
tried to resolve this with
wmesmfmd.F90to no luck. I'm won't list either as complete in the checkbox list untilthese have been resolved, which will have to be in a follow on PR.
What bug does it fix, or what feature does it add?
doxygendocumentation is added.Is a change of answers expected from this PR?
Please also include the following information:
doxygenmark-up (seen as comments to the compiler) have been added.Issue(s) addressed
Commit Message
doxygen documentation: 6th subset
Check list
Testing
How were these changes tested?
Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
Have the matrix regression tests been run (if yes, please note HPC and compiler)?
Please indicate the expected changes in the regression test output, (Note the list of known non-identical tests.)