Skip to content

Commit

Permalink
moved more defgroups to beginning of file
Browse files Browse the repository at this point in the history
  • Loading branch information
edhartnett committed May 30, 2019
1 parent 9bccea5 commit f608641
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 21 deletions.
8 changes: 4 additions & 4 deletions src/flib/pio.F90
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
!! @author Jim Edwards
!<

!>
!! @defgroup PIO_set_blocksize PIO_set_blocksize
!! Set the box rearranger blocksize.

module pio
! Package all exposed variables and functions under one roof

Expand Down Expand Up @@ -77,10 +81,6 @@ module pio
implicit none
public
contains
!>
!! @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
Expand Down
35 changes: 18 additions & 17 deletions src/flib/piolib_mod.F90
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@
!! Initialization Routines for PIO.
!!
!<

!>
!! @defgroup PIO_openfile PIO_openfile
!! @defgroup PIO_syncfile PIO_syncfile
!! @defgroup PIO_createfile Create a File
!! @defgroup PIO_setframe PIO_setframe
!! @defgroup PIO_advanceframe PIO_advanceframe
!! @defgroup PIO_closefile PIO_closefile
!! @defgroup PIO_freedecomp PIO_freedecomp
!! @defgroup PIO_init PIO_init
!! @defgroup PIO_finalize PIO_finalize
!! @defgroup PIO_initdecomp PIO_initdecomp
!! @defgroup PIO_getnumiotasks PIO_getnumiotasks
!! @defgroup PIO_setdebuglevel PIO_setdebuglevel
!! @defgroup PIO_seterrorhandling PIO_seterrorhandling
!! @defgroup PIO_get_local_array_size PIO_get_local_array_size
!! @defgroup PIO_set_hint PIO_set_hint

module piolib_mod
use iso_c_binding
!--------------
Expand Down Expand Up @@ -65,31 +83,27 @@ module piolib_mod
!
!-----------------------------------------------------------------------
!>
!! @defgroup PIO_openfile PIO_openfile
!! Open an existing netCDF file.
!<
interface PIO_openfile
module procedure PIO_openfile
end interface

!>
!! @defgroup PIO_syncfile PIO_syncfile
!! Sync the file to disk, flushing all buffers.
!<
interface PIO_syncfile
module procedure syncfile
end interface

!>
!! @defgroup PIO_createfile Create a File
!! Create a new netCDF file with PIO.
!<
interface PIO_createfile
module procedure createfile
end interface

!>
!! @defgroup PIO_setframe PIO_setframe
!! Sets the record number for a future read/write of distributed
!! arrays (see @ref PIO_write_darray, @ref PIO_read_darray).
!<
Expand All @@ -98,7 +112,6 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_advanceframe PIO_advanceframe
!! Increment the record number for a future read/write of distributed
!! arrays (see @ref PIO_write_darray, @ref PIO_read_darray).
!<
Expand All @@ -107,15 +120,13 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_closefile PIO_closefile
!! Close an open file.
!<
interface PIO_closefile
module procedure closefile
end interface

!>
!! @defgroup PIO_freedecomp PIO_freedecomp
!! Free memory associated with a decomposition.
!<
interface PIO_freedecomp
Expand All @@ -124,7 +135,6 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_init PIO_init
!! Initializes the PIO subsystem, creating a new IOSystem.
!<
interface PIO_init
Expand All @@ -134,15 +144,13 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_finalize PIO_finalize
!! Shuts down an IOSystem and associated resources.
!<
interface PIO_finalize
module procedure finalize
end interface

!>
!! @defgroup PIO_initdecomp PIO_initdecomp
!! PIO_initdecomp is an overload interface the models decomposition to pio.
!! initdecomp_1dof_bin_i8, initdecomp_1dof_nf_i4, initdecomp_2dof_bin_i4,
!! and initdecomp_2dof_nf_i4 are all depreciated, but supported for backwards
Expand All @@ -164,7 +172,6 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_getnumiotasks PIO_getnumiotasks
!! Return the actual number of IO-tasks used. PIO will reset the
!! total number of IO-tasks if certain conditions are meet.
!<
Expand All @@ -176,15 +183,13 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_setdebuglevel PIO_setdebuglevel
!! Set the level of debug information that PIO will generate.
!<
interface PIO_setdebuglevel
module procedure setdebuglevel
end interface

!>
!! @defgroup PIO_seterrorhandling PIO_seterrorhandling
!! Set the form of error handling for PIO.
!!
!! By default pio handles errors internally by printing a string
Expand All @@ -202,7 +207,6 @@ module piolib_mod
end interface

!>
!! @defgroup PIO_get_local_array_size PIO_get_local_array_size
!! Get the local size of a distributed array.
!<

Expand Down Expand Up @@ -1157,9 +1161,6 @@ subroutine init_intercom(component_count, peer_comm, comp_comms, io_comm, iosyst
#endif
end subroutine init_intercom

!>
!! @defgroup PIO_set_hint PIO_set_hint

!> @ingroup PIO_set_hint
!! Set file system hints using mpi_info_set. This is a collective
!! call.
Expand Down

0 comments on commit f608641

Please sign in to comment.