Skip to content

Commit

Permalink
Doxygen in EXCH.f, FDLVL.f, FILL_PSETFLD.f, FRZLVL.f, and FRZLVL2.f. (#…
Browse files Browse the repository at this point in the history
…470)

* This is part of Issue #392.

Fixes the doxygen warnings in EXCH.f, FDLVL.f, FILL_PSETFLD.f, FRZLVL.f, and FRZLVL2.f.

* Minor fix and Added new features from Ed's comments.

* Format enhancement from Edward's comments.

* Updated documentation.
  • Loading branch information
kayeekayee committed Apr 6, 2022
1 parent 40fbb3f commit 3c4a56e
Show file tree
Hide file tree
Showing 5 changed files with 273 additions and 431 deletions.
61 changes: 23 additions & 38 deletions sorc/ncep_post.fd/EXCH.f
Original file line number Diff line number Diff line change
@@ -1,37 +1,21 @@
!> @file
!
!> SUBPROGRAM: EXCH EXCHANGE ONE HALO ROW
!! PRGRMMR: TUCCILLO ORG: IBM
!!
!! ABSTRACT:
!! EXCHANGE ONE HALO ROW
!!
!! PROGRAM HISTORY LOG:
!! 00-01-06 TUCCILLO - ORIGINAL
!!
!! USAGE: CALL EXCH(A)
!! INPUT ARGUMENT LIST:
!! A - ARRAY TO HAVE HALOS EXCHANGED
!!
!! OUTPUT ARGUMENT LIST:
!! A - ARRAY WITH HALOS EXCHANGED
!!
!! OUTPUT FILES:
!! STDOUT - RUN TIME STANDARD OUT.
!!
!! SUBPROGRAMS CALLED:
!! MPI_SENDRECV
!! UTILITIES:
!! NONE
!! LIBRARY:
!! COMMON - CTLBLK.comm
!!
!@PROCESS NOCHECK
!
!--- The 1st line is an inlined compiler directive that turns off -qcheck
! during compilation, even if it's specified as a compiler option in the
! makefile (Tuccillo, personal communication; Ferrier, Feb '02).
!
!> @brief Subroutines that exchange one halo row.
!>
!> These routines are to exchange one halo row.
!>
!> @param[in] A Array to have halos exchanged.
!> @param[out] A Array with halos exchanged.
!>
!> ### Program history log:
!> Date | Programmer | Comments
!> -----|------------|---------
!> 2000-01-06 | Jim Tuccillo | Initial
!>
!> @note The 1st line is an inlined compiler directive that turns off -qcheck
!> during compilation, even if it's specified as a compiler option in the
!> makefile (Tuccillo, personal communication; Ferrier, Feb '02).
!>
!> @author Jim Tuccillo IBM @date 2000-01-06
SUBROUTINE EXCH(A)

use ctlblk_mod, only: num_procs, jend, iup, jsta, idn, mpi_comm_comp, im,&
Expand Down Expand Up @@ -72,11 +56,12 @@ SUBROUTINE EXCH(A)
end

!!@PROCESS NOCHECK
!
!--- The 1st line is an inlined compiler directive that turns off -qcheck
! during compilation, even if it's specified as a compiler option in the
! makefile (Tuccillo, personal communication; Ferrier, Feb '02).
!
!>
!> @note The 1st line is an inlined compiler directive that turns off -qcheck
!> during compilation, even if it's specified as a compiler option in the
!> makefile (Tuccillo, personal communication; Ferrier, Feb '02).
!>
!> @author Jim Tuccillo IBM @date 2000-01-06
subroutine exch_f(a)

use ctlblk_mod, only: num_procs, jend, iup, jsta, idn, &
Expand Down
Loading

0 comments on commit 3c4a56e

Please sign in to comment.