Skip to content

Doxygen header templates#585

Merged
aliabdolali merged 3 commits into
NOAA-EMC:developfrom
MatthewMasarik-NOAA:fb/doxy-headers
Jan 24, 2022
Merged

Doxygen header templates#585
aliabdolali merged 3 commits into
NOAA-EMC:developfrom
MatthewMasarik-NOAA:fb/doxy-headers

Conversation

@MatthewMasarik-NOAA
Copy link
Copy Markdown
Contributor

Pull Request Summary

Acceptance of doxygen headers to be used for documentation of WW3 Fortran source code units.

Description

Provide a detailed description of what this PR does.

  • Adds a markdown file (./docs/ww3_doxy_tmpl.md) which will serve as a reference for required header tags when marking up WW3 source for doxygen.
  • A docs/ folder is also added which will eventually hold the documentation.
  • An initial version of the doxygen config file, Doxygen.in, is also included in docs/.

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

  • N/A.

Is a change of answers expected from this PR?

  • No. No changes to source code at this time.

Mention any labels that should be added:

  • documentation.

Issue(s) addressed

Please list any issues associated with this PR, including those the PR will fix/close.

  • fixes noaa-emc/ww3/issues/#547.

Commit Message

ww3_doxy_tmpl.md: add doxygen header templates

Check list

Testing

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

@JessicaMeixner-NOAA
Copy link
Copy Markdown
Collaborator

@aliabdolali what are we waiting for to merge this PR in?

@aliabdolali
Copy link
Copy Markdown
Contributor

@aliabdolali what are we waiting for to merge this PR in?

I needed time to do my final review.

@aliabdolali aliabdolali merged commit d95482a into NOAA-EMC:develop Jan 24, 2022
Comment thread docs/ww3_doxy_tmpl.md
Comment thread docs/ww3_doxy_tmpl.md
Comment thread docs/ww3_doxy_tmpl.md
Comment thread docs/ww3_doxy_tmpl.md
Comment thread docs/ww3_doxy_tmpl.md
Comment thread docs/ww3_doxy_tmpl.md
@MatthewMasarik-NOAA MatthewMasarik-NOAA deleted the fb/doxy-headers branch January 24, 2022 15:42
kestonsmith-noaa pushed a commit to kestonsmith-noaa/WW3 that referenced this pull request Jun 17, 2025
…water normalization in CMEPS (#549) (NOAA-EMC#585)


* add default variables for v16 non-tiled inputs
* add script for tiled fix input
* add new v16 noahmp test to rt.conf
* remove satemdf suite from s2sw compile (unused)
* add gaea.intel to rt_35d.conf
* add landice variable
* add landice setting to benchmark_v16 nml
* set landice true for non-noahmp
* set landice=false for v16 noahmp tests
* add aofrac_normalization
* commit removal of fd_nems from correct branch
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.

4 participants