dOxyGenized arguments in MOM_energetic_PBL.F90

Added dOxyGen comments for several recently added arguments in MOM_energetic_PBL.F90 where they had been omitted. All answers are bitwise identical.
NOAA-GFDL · May 3, 2018 · 86818dd · 86818dd
1 parent 825e9bb
commit 86818dd
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/parameterizations/vertical/MOM_energetic_PBL.F90 b/src/parameterizations/vertical/MOM_energetic_PBL.F90
@@ -266,8 +266,15 @@ subroutine energetic_PBL(h_3d, u_3d, v_3d, tv, fluxes, dt, Kd_int, G, GV, CS, &
                                                    !! diagnostics will be written. The default
                                                    !! is .true.
   real, dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
-                 optional, intent(out)   :: dT_expected, dS_expected
-  type(wave_parameters_CS), pointer, optional :: Waves !<Wave CS
+                 optional, intent(out)   :: dT_expected !< The values of temperature change that
+                                                   !! should be expected when the returned
+                                                   !! diffusivities are applied, in K.
+  real, dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
+                 optional, intent(out)   :: dS_expected !< The values of salinity change that
+                                                   !! should be expected when the returned
+                                                   !! diffusivities are applied, in psu.
+  type(wave_parameters_CS), &
+                 optional, pointer       :: Waves  !< Wave CS
 
 !    This subroutine determines the diffusivities from the integrated energetics
 !  mixed layer model.  It assumes that heating, cooling and freshwater fluxes