doxygenated fv3_cap.F90

[AlysonStahl-NOAA]

trafficstars

Description

More doxygen

Issue(s) addressed

Part of #760

Testing

Documentation changes only

Dependencies

N/A

[edwardhartnett]

@AlexanderRichert-NOAA can you get the fv3atm CI working again?

[AlexanderRichert-NOAA]

@DusanJovic-NOAA what's the status of the mpi_f08 issue, did you work out a fix?

[DusanJovic-NOAA]

@AlexanderRichert-NOAA Yes, mpi_f08 will be fixed in #805, which is merged with #811 which will be merged soon. But unfortunately there was an update in upp which is causing workflow to fail now at:

sed -i 's/doc /upp_doc /' upp/docs/CMakeLists.txt

So, we'll need one more update. Do you want to fix this (remove that sed command) in your 'Add unit testing' PR?

[edwardhartnett]

It's not a rush, if a fix is coming we can wait for it...

I just wanted to get the CI working again so we can start running doxygen in it.

[AlexanderRichert-NOAA]

I would recommend fixing the sed failure in #811, just so we don't keep merging PRs where the CI isn't working. That said, I agree it should be as simple as removing that line since the custom target in UPP now has the name 'upp_doc' already.

[DusanJovic-NOAA]

ufs-wm code managers already started or actually finished regression testing, so that change must go in as part of the next PR.

[DusanJovic-NOAA]

@AlexanderRichert-NOAA @edwardhartnett I removed that sed command from fv3atm workflow file that renames 'doc' to 'upp_doc' in the UPP's CMakeLists.txt but the workflow is still failing:

https://github.com/NOAA-EMC/fv3atm/actions/runs/8833224366/job/24252100176#step:6:220

There is a mismatch in the name of doc folders in UPP version fv3atm is using. I see that is fixed 3 days ago in UPP https://github.com/NOAA-EMC/UPP/pull/932/files

@WenMeng-NOAA Looks like we will need another fv3atm PR that updates UPP submodule.