Skip to content
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

WW3 doxygen reference: update templates with examples #783

Conversation

MatthewMasarik-NOAA
Copy link
Collaborator

@MatthewMasarik-NOAA MatthewMasarik-NOAA commented Sep 14, 2022

Pull Request Summary

Updates the WW3 doxygen reference for header templates with examples.

Description

Provide a detailed description of what this PR does.

  • This PR provides a complete re-write of the template reference for doxygen. It now contains:
    • Raw header templates for easy copy/paste.
    • Examples for each header with input from original WW3 headers.
    • Treatment of inline documentation for MODULE variables.

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

  • Only documentation is added. In this case it expanded and clarified what previously existed.

Is a change of answers expected from this PR?

  • No. Only the markdown file, ww3_doxy_tmpl.md changed.

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 will change -- no modification to any code, only documentation.

Issue(s) addressed

  • Please list any issues associated with this PR, including those the PR will fix/close. For example:
    • This did not have a distinct issue. It was related to the Code Standards, and having a sufficient resource for developers to refer to for WW3 doxygen documentation.

Commit Message

WW3 doxygen reference: update templates with examples

Check list

Testing

  • How were these changes tested?

    • No testing. Documentation changes cannot be tested. No changes to code.
  • Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)

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

    • No. It is not required for documentation.
  • Please indicate the expected changes in the regression test output, (Note the list of known non-identical tests.)

    • N/A. See above.
  • Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

    • N/A. See above.

@MatthewMasarik-NOAA
Copy link
Collaborator Author

I've updated to remove *.png images and links to them in the ww3_doxy_tmpl.md file.

@JessicaMeixner-NOAA JessicaMeixner-NOAA merged commit ff0b256 into NOAA-EMC:develop Sep 15, 2022
@MatthewMasarik-NOAA MatthewMasarik-NOAA deleted the doc/doxygen_templates_update branch September 15, 2022 18:48
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