Skip to content

Commit

Permalink
more fortran doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
edhartnett committed May 29, 2019
1 parent f1b72e1 commit 5167124
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 68 deletions.
47 changes: 23 additions & 24 deletions src/flib/pio.F90
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
!>
!! @file
!! @brief User interface Module for PIO, this is the only file a user program should 'use'
!!
!! User interface Module for PIO, this is the only file a user program should 'use'.
!! @author Jim Edwards
!<

module pio
Expand Down Expand Up @@ -77,15 +77,15 @@ module pio
implicit none
public
contains
!>
!! @public
!! @defgroup PIO_set_blocksize
!<
!>
!! @public
!! @ingroup PIO_set_blocksize
!! @brief Set the target blocksize for the box rearranger
!<
!>
!! @defgroup PIO_set_blocksize PIO_set_blocksize
!! Set the box rearranger blocksize.
!<
!>
!! @ingroup PIO_set_blocksize
!! @brief Set the target blocksize for the box rearranger
!! @author Jim Edwards
!<
subroutine pio_set_blocksize(blocksize)
integer :: blocksize
integer :: ierr
Expand All @@ -100,10 +100,10 @@ end function PIOc_set_blocksize
end subroutine pio_set_blocksize


!>
!! @public
!! @brief Logical function returns true if the task is an IO task.
!<
!>
!! Logical function returns true if the task is an IO task.
!! @author Jim Edwards
!<
function pio_iam_iotask(iosystem) result(task)
use iso_c_binding
type(iosystem_desc_t), intent(in) :: iosystem
Expand All @@ -123,10 +123,10 @@ end function PIOc_iam_iotask
task = ctask
end function pio_iam_iotask

!>
!! @public
!! @brief Integer function returns rank of IO task.
!<
!>
!! Integer function returns rank of IO task.
!! @author Jim Edwards
!<
function pio_iotask_rank(iosystem) result(rank)
type(iosystem_desc_t), intent(in) :: iosystem
integer :: rank, ierr
Expand All @@ -142,10 +142,10 @@ end function PIOc_iotask_rank
ierr = PIOc_iotask_rank(iosystem%iosysid, rank)
end function pio_iotask_rank

!>
!! @public
!! @brief Sets active to true if IO system is active.
!<
!>
!! Sets active to true if IO system is active.
!! @author Jim Edwards
!<
subroutine pio_iosystem_is_active(iosystem, active)
use iso_c_binding
type(iosystem_desc_t), intent(in) :: iosystem
Expand All @@ -165,6 +165,5 @@ end function PIOc_iosystem_is_active
active = lactive
end subroutine pio_iosystem_is_active


end module pio

Loading

0 comments on commit 5167124

Please sign in to comment.