Doc/doxygen no errors

[MatthewMasarik-NOAA]

Pull Request Summary

Fixes the existing doxygen errors prior to submitting doxygen marked-up code.

Description

Doxygen scans and generates some amount of documentation for code even without adding doxygen markup to it. It's possible for legal code to cause the doxygen parser to become confused and produce an error. It was suggested by @edwardhartnett to remove all errors from a code base, then going forward require all submissions to be doxygen-error free. This PR removes the remaining doxygen errors in the code base.

Please also include the following information:

• Add any suggestions for a reviewer
  • N/A.
• Mention any labels that should be added:
  • documentation.
• Are answer changes expected from this PR? Please describe the changes and the reason why in addition to which of the following labels would apply:
  • No answers are expected to change. There were edits to the source code, but only to express the same statements in a slightly different way to satisfy the doxygen parser. The meaning of both expressions is identical.

Issue(s) addressed

N/A.

Commit Message

doxygen: remove existing doxygen errors prior to markup

Check list

• Branch is up to date with the authoritative repository (NOAA-EMC) develop branch.
• Checked the checklist for a developer submitting to develop.
• [na] If a version number update is required, checked the updating version number checklist.
• [na] If a new feature was added, a regression test for testing the new feature is added.

Testing

• How were these changes tested?

  • The full matrix was run against current develop.

• Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)

  • No. The changes are for documentation purposes, not functionality.

• Have the matrix regression tests been run (if yes, please note HPC and compiler)?

  • Yes. hera.intel.

• Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

  • matrixCompSummary(1).txt
  • matrixCompFull(1).txt
  • matrixDiff(1).txt

• Please indicate the expected changes in the regression test output (Note the known list of non-identical tests).

  • Only entries in the list of known non-identical cases.

• Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

**********************************************************************
********************* non-identical cases ****************************
**********************************************************************
mww3_test_03/./work_PR2_UQ_MPI_d2                     (15 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c                     (13 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2                     (15 files differ)
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_UQ_MPI_d2_c                     (15 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2                     (16 files differ)
ww3_tp2.10/./work_MPI_OMPH                     (6 files differ)
ww3_tp2.16/./work_MPI_OMPH                     (5 files differ)
ww3_ufs1.1/./work_d                     (0 files differ)
ww3_ufs1.2/./work_b                     (0 files differ)
ww3_ufs1.3/./work_a                     (1 files differ)
 
**********************************************************************
************************ identical cases *****************************
**********************************************************************

[JessicaMeixner-NOAA]

Regtests were as expected and posted here.

matrixDiff.txt
matrixCompFull.txt
matrixCompSummary.txt