Update documentation

E3SM-Project · Sep 27, 2023 · 636fcbf · 636fcbf
1 parent 78286bf
commit 636fcbf
Show file tree

Hide file tree

Showing 5 changed files with 167 additions and 88 deletions.
diff --git a/columnphysics/icepack_mushy_physics.F90 b/columnphysics/icepack_mushy_physics.F90
@@ -141,6 +141,7 @@ subroutine conductivity_snow_array(ks)
   end subroutine conductivity_snow_array
 
 !=======================================================================
+!autodocument_start icepack_enthalpy_snow
 ! Enthalpy of snow from snow temperature
 
   function icepack_enthalpy_snow(zTsn) result(zqsn)
@@ -151,6 +152,8 @@ function icepack_enthalpy_snow(zTsn) result(zqsn)
     real(kind=dbl_kind) :: &
          zqsn ! snow layer enthalpy (J m-3)
 
+!autodocument_end
+
     character(len=*),parameter :: subname='(icepack_enthalpy_snow)'
 
     zqsn = -rhos * (-cp_ice * zTsn + Lfresh)
@@ -260,6 +263,7 @@ function liquidus_temperature_mush(Sbr) result(zTin)
   end function liquidus_temperature_mush
 
 !=======================================================================
+!autodocument_start icepack_enthalpy_mush
 ! Enthalpy of mush from mush temperature and bulk salinity
 
   function icepack_enthalpy_mush(zTin, zSin) result(zqin)
@@ -271,6 +275,8 @@ function icepack_enthalpy_mush(zTin, zSin) result(zqin)
     real(kind=dbl_kind) :: &
          zqin    ! ice layer enthalpy (J m-3)
 
+!autodocument_end
+
     real(kind=dbl_kind) :: &
          phi     ! ice liquid fraction
 

diff --git a/columnphysics/icepack_therm_shared.F90 b/columnphysics/icepack_therm_shared.F90
@@ -278,7 +278,7 @@ function icepack_salinity_profile(zn) result(salinity)
       real(kind=dbl_kind) :: &
          salinity ! initial salinity profile
 
-!autodocument end
+!autodocument_end
 
       real (kind=dbl_kind), parameter :: &
          nsal    = 0.407_dbl_kind, &

diff --git a/columnphysics/icepack_warnings.F90 b/columnphysics/icepack_warnings.F90
@@ -92,12 +92,16 @@ subroutine icepack_warnings_clear()
       end subroutine icepack_warnings_clear
 
 !=======================================================================
+!autodocument_start icepack_warnings_clear
+! return an array of all the current warning messages
 
       subroutine icepack_warnings_getall(warningsOut)
 
         character(len=char_len_long), dimension(:), allocatable, intent(out) :: &
              warningsOut
 
+!autodocument_end
+
         integer :: iWarning
         character(len=*),parameter :: subname='(icepack_warnings_getall)'