-
Notifications
You must be signed in to change notification settings - Fork 559
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 documentation: 6th subset #841
doxygen documentation: 6th subset #841
Conversation
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.
********************* 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
doxygen
marked source files.Description
Provide a detailed description of what this PR does.
Adds
doxygen
documentation for the following files:ww3_systrk.F90
ww3_outp.F90
ww3_outf.F90
ww3_gspl.F90
w3updtmd.F90
w3triamd.F90
w3srcemd.F90
w3src6md.F90
w3src4md.F90
w3src3md.F90
Note: the files
wmesmfmd.F90
andw3uostmd.F90
have 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.F90
to 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?
doxygen
documentation is added.Is a change of answers expected from this PR?
Please also include the following information:
doxygen
mark-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.)