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

Fixes doxygen warnings mostly from config_src/external #1231

Merged
merged 2 commits into from
Oct 28, 2020
Merged

Fixes doxygen warnings mostly from config_src/external #1231

merged 2 commits into from
Oct 28, 2020

Conversation

adcroft
Copy link
Collaborator

@adcroft adcroft commented Oct 24, 2020

  • Rob's documentation framework #1225 is showing lots of errors due to using a newer version of doxygen
  • These doxygen mistakes exist in the current dev/gfdl branch and apparently are missed by the older versions we are using on mom6.readthedocs.io and locally.

Todo:
[ ] - Have the OBGC routines properly documented so we can replace the "Unknown" documentation in the generic_tracer stubs.

- #1225 is showing lots of errors due to using a newer version of doxygen
- These doxygen mistakes exist in the current dev/gfdl branch and apparently
  are missed by the older versions we are using on mom6.readthedocs.io and
  locally.

Todo:
[ ] - Have the OBGC routines properly documented so we can replace the
      "Unknown" documentation in the generic_tracer stubs.
@codecov-io
Copy link

codecov-io commented Oct 24, 2020

Codecov Report

Merging #1231 into dev/gfdl will decrease coverage by 0.05%.
The diff coverage is 33.62%.

Impacted file tree graph

@@             Coverage Diff              @@
##           dev/gfdl    #1231      +/-   ##
============================================
- Coverage     46.08%   46.03%   -0.06%     
============================================
  Files           214      224      +10     
  Lines         69399    71042    +1643     
============================================
+ Hits          31984    32702     +718     
- Misses        37415    38340     +925     
Impacted Files Coverage Δ
...g_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90 0.00% <0.00%> (ø)
...fig_src/external/GFDL_ocean_BGC/generic_tracer.F90 0.00% <0.00%> (ø)
...c/external/GFDL_ocean_BGC/generic_tracer_utils.F90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/kdtree.f90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/ocean_da_core.F90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/ocean_da_types.F90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/write_ocean_obs.F90 0.00% <0.00%> (ø)
config_src/solo_driver/MESO_surface_forcing.F90 0.00% <0.00%> (ø)
config_src/solo_driver/user_surface_forcing.F90 0.00% <0.00%> (ø)
src/ALE/MOM_regridding.F90 31.47% <0.00%> (-0.17%) ⬇️
... and 220 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bf8c79f...cedfea7. Read the comment docs.

@Hallberg-NOAA
Copy link
Collaborator

The pipeline testing for this PR is at https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/11453 .

Copy link
Collaborator

@Hallberg-NOAA Hallberg-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that these corrections to the dOxygen comments will avoid syntax errors, although there are a distressingly large number of uninformative"Unknown" descriptions that need to be corrected.

@Hallberg-NOAA Hallberg-NOAA merged commit 3fcc8cc into mom-ocean:dev/gfdl Oct 28, 2020
@adcroft adcroft deleted the config-src-doxygen-fixes branch November 2, 2020 22:12
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.

3 participants