Skip to content

ww3_doxy_tmpl.md: clarify MODULE markup#606

Merged
JessicaMeixner-NOAA merged 1 commit into
NOAA-EMC:developfrom
MatthewMasarik-NOAA:doc/header-fix
Feb 9, 2022
Merged

ww3_doxy_tmpl.md: clarify MODULE markup#606
JessicaMeixner-NOAA merged 1 commit into
NOAA-EMC:developfrom
MatthewMasarik-NOAA:doc/header-fix

Conversation

@MatthewMasarik-NOAA
Copy link
Copy Markdown
Contributor

Pull Request Summary

Clarifies the doxygen markup specific to Fortran MODULE.

Description

Provide a detailed description of what this PR does.

  • Corrects the doxygen markup that is needed for the MODULE Fortran code unit. The previous doxygen fix PR clarified that the @param tag was not used for MODULE variables. In hindsight, it should have also been clarified that there are two sections for it: a header that stays above the MODULE line, and then the inline variable documentation that go below it.

What bug does it fix, or what feature does it add?

  • Addresses a confusing part of the header template file, docs/ww3_doxy_tmpl.md.

Is a change of answers expected from this PR?

  • No. Only the header template file has been changed.

Please also include the following information:

  • Add any suggestions for a reviewer

  • 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. No source code has been edited.

Issue(s) addressed

  • Please list any issues associated with this PR, including those the PR will fix/close. For example:
    • N/A.

Commit Message

ww3_doxy_tmpl.md: clarify MODULE markup

Check list

Testing

  • How were these changes tested?
    • No source code changes, so nothing to test.
  • Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
    • No. Not required for documentation.
  • Have the matrix regression tests been run (if yes, please note HPC and compiler)?
    • N/A. See above.
  • Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):
    • N/A. See above.
  • Please indicate the expected changes in the regression test output (Note the known list of non-identical tests).
    • No changes.
  • Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):
    • N/A. See above.

@JessicaMeixner-NOAA
Copy link
Copy Markdown
Collaborator

No regtests run as it's just a doxygen file update

@JessicaMeixner-NOAA JessicaMeixner-NOAA merged commit e6d27b9 into NOAA-EMC:develop Feb 9, 2022
@MatthewMasarik-NOAA MatthewMasarik-NOAA deleted the doc/header-fix branch March 7, 2022 15:03
kestonsmith-noaa pushed a commit to kestonsmith-noaa/WW3 that referenced this pull request Jun 17, 2025
* removing ncld from .IN files in parm
* reinsatating original rt.conf
* adding module purge to compile.sh
* updating some .IN files to remove ncld
* fixing control_ras and some other fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants