Added API documentation for chkerr()

NOAA-GFDL · Jan 20, 2021 · c05b042 · c05b042
1 parent 172025d
commit c05b042
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/config_src/nuopc_driver/mom_cap_methods.F90 b/config_src/nuopc_driver/mom_cap_methods.F90
@@ -939,6 +939,7 @@ subroutine field_getfldptr(field, fldptr1, fldptr2, rank, abort, rc)
 
 end subroutine field_getfldptr
 
+!> Returns true if ESMF_LogFoundError() determines that rc is an error code. Otherwise false.
 logical function ChkErr(rc, line, file)
   integer, intent(in) :: rc            !< return code to check
   integer, intent(in) :: line          !< Integer source line number