documentation

NOAA-GFDL · May 30, 2024 · 95c2890 · 95c2890
1 parent 73c84e3
commit 95c2890
Showing 1 changed file with 10 additions and 8 deletions.
diff --git a/full/full_coupler_mod.F90 b/full/full_coupler_mod.F90
@@ -228,6 +228,8 @@ module full_coupler_mod
                          use_hyper_thread, concurrent_ice, slow_ice_with_ocean,    &
                          do_endpoint_chksum, combined_ice_and_ocean
 
+  !> coupler_clock_type derived type consist of all clock ids that will be set and used
+  !! in full coupler_main.
   type coupler_clock_type 
     integer :: initialization
     integer :: main
@@ -1529,14 +1531,14 @@ subroutine coupler_set_clock_ids(coupler_clocks, Atm, Land, Ice, Ocean, ensemble
 
     implicit none
 
-    type(coupler_clock_type), intent(inout) :: coupler_clocks
-    type(atmos_data_type),   intent(in) :: Atm
-    type(land_data_type),    intent(in) :: Land
-    type(ocean_public_type), intent(in) :: Ocean
-    type(ice_data_type),     intent(in) :: Ice
-    integer, dimension(:),   intent(in) :: slow_ice_ocean_pelist
-    integer, dimension(:,:), intent(in) :: ensemble_pelist
-    integer, intent(in) :: ensemble_id    
+    type(coupler_clock_type), intent(inout) :: coupler_clocks !< coupler_clocks
+    type(atmos_data_type),   intent(in) :: Atm   !< Atm, required to retrieve pe information
+    type(land_data_type),    intent(in) :: Land  !< Land, required to retrieve pe information
+    type(ocean_public_type), intent(in) :: Ocean !< Ocean, required to retrieve pe information
+    type(ice_data_type),     intent(in) :: Ice   !< Ice, required to retrieve pe information
+    integer, dimension(:),   intent(in) :: slow_ice_ocean_pelist !< slow_ice_oean_pelist
+    integer, dimension(:,:), intent(in) :: ensemble_pelist       !< ensemble_pelist
+    integer, intent(in) :: ensemble_id !< ensemble_id used as index in ensemble_pelist
 
     !> initialization clock
     if (Atm%pe) then