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

What is the extra comment-formatting in atmos_model.F90? Is it used anywhere? #761

Open
edwardhartnett opened this issue Jan 17, 2024 · 0 comments

Comments

@edwardhartnett
Copy link
Contributor

edwardhartnett commented Jan 17, 2024

We seem to have some comments in atmos_model.F90 which appear to be some home-rolled documentation system. For example:

!#######################################################################
! <SUBROUTINE NAME="update_atmos_chemistry">
! <DESCRIPTION>
!  Populate exported chemistry fields with current atmospheric state
!  data (state='export'). Update tracer concentrations for atmospheric
!  chemistry with values from chemistry component (state='import').
!  Fields should be exported/imported from/to the atmospheric state
!  after physics calculations.
!
!  NOTE: It is assumed that all the chemical tracers follow the standard
!  atmospheric tracers, which end with ozone. The order of the chemical
!  tracers must match their order in the chemistry component.
!
!  Requires:
!         GFS_data
!         Atm_block
! </DESCRIPTION>
subroutine update_atmos_chemistry(state, rc)

Seems like this business with "DESCRIPTION" and other html-like tags are someone's idea of how to do a doxygen-like documentation build, but without using doxygen, instead using some home-rolled code.

Is this in use by anyone?

Could this be some ESMF hack?

Or what is going on here?

We are doxygenating fv3atm. Do we need to preserve this stuff as well?

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

No branches or pull requests

1 participant