add documentation for function ChkErr

NOAA-GFDL · Jan 20, 2021 · 172025d · 172025d
1 parent 633dc92
commit 172025d
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/config_src/nuopc_driver/mom_cap_methods.F90 b/config_src/nuopc_driver/mom_cap_methods.F90
@@ -940,9 +940,9 @@ subroutine field_getfldptr(field, fldptr1, fldptr2, rank, abort, rc)
 end subroutine field_getfldptr
 
 logical function ChkErr(rc, line, file)
-  integer, intent(in) :: rc
-  integer, intent(in) :: line
-  character(len=*), intent(in) :: file
+  integer, intent(in) :: rc            !< return code to check
+  integer, intent(in) :: line          !< Integer source line number
+  character(len=*), intent(in) :: file !< User-provided source file name
   integer :: lrc
   ChkErr = .false.
   lrc = rc