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

Remove doxygen warnings from gblevents #1014

Open
GeorgeGayno-NOAA opened this issue Jan 16, 2025 · 2 comments · May be fixed by #1015
Open

Remove doxygen warnings from gblevents #1014

GeorgeGayno-NOAA opened this issue Jan 16, 2025 · 2 comments · May be fixed by #1015
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@GeorgeGayno-NOAA
Copy link
Collaborator

The module variables are not defined. This is causing warnings when creating the Doxgyen.

gblevents.f:17: warning: Member dlat (variable) of module gblevn_module is not documented.
gblevents.f:17: warning: Member dlon (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iar12z (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iar13p (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iar14t (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iar15u (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iar16v (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iar17q (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iarpsd (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iarpsi (variable) of module gblevn_module is not documented.
gblevents.f:11: warning: Member iarpsl (variable) of module gblevn_module is not documented.
gblevents.f:10: warning: Member idsl (variable) of module gblevn_module is not documented.
gblevents.f:10: warning: Member idvc (variable) of module gblevn_module is not documented.
gblevents.f:9: warning: Member imax (variable) of module gblevn_module is not documented.
gblevents.f:9: warning: Member jmax (variable) of module gblevn_module is not documented.
gblevents.f:9: warning: Member kmax (variable) of module gblevn_module is not documented.
gblevents.f:9: warning: Member kmaxs (variable) of module gblevn_module is not documented.
gblevents.f:10: warning: Member nvcoord (variable) of module gblevn_module is not documented.
gblevents.f:10: warning: Member sfcpress_id (variable) of module gblevn_module is not documented.
gblevents.f:10: warning: Member thermodyn_id (variable) of module gblevn_module is not documented.
gblevents.f:16: warning: Member vcoord (variable) of module gblevn_module is not documented.

Should be a quick fix.

@GeorgeGayno-NOAA GeorgeGayno-NOAA added bug Something isn't working documentation Improvements or additions to documentation labels Jan 16, 2025
@GeorgeGayno-NOAA GeorgeGayno-NOAA self-assigned this Jan 16, 2025
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Jan 16, 2025
@GeorgeGayno-NOAA
Copy link
Collaborator Author

The Doxygen was built on Hera using 4e3dcf3. All warnings from gblevents.f were gone.

@GeorgeGayno-NOAA
Copy link
Collaborator Author

Here is the Doxygen from the branch:
https://www.emc.ncep.noaa.gov/jcsda/ggayno/doxygen/html/gblevents/gblevents_8f.html

Here is the current Doxygen:
https://ufs-community.github.io/UFS_UTILS/gblevents/gblevents_8f.html

Note the Variables section now contains definitions.

@GeorgeGayno-NOAA GeorgeGayno-NOAA linked a pull request Jan 16, 2025 that will close this issue
1 task
GeorgeGayno-NOAA added a commit to GeorgeGayno-NOAA/UFS_UTILS that referenced this issue Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant