more docs work

rfiorella · May 30, 2019 · fe90e61 · fe90e61
1 parent ad98a0b
commit fe90e61
Showing 1 changed file with 43 additions and 88 deletions.
diff --git a/src/flib/piodarray.F90.in b/src/flib/piodarray.F90.in
@@ -1,7 +1,7 @@
 #define __PIO_FILE__ 'piodarray'
 !>
 !! @file
-!! @brief Read and write routines for decomposed data.
+!! Read and write routines for decomposed data.
 module piodarray
   use pio_types, only : file_desc_t, io_desc_t, var_desc_t
   use pio_kinds, only : i4, r4, r8, pio_offset_kind
@@ -18,7 +18,7 @@ module piodarray
 
 !>
 !! @defgroup PIO_write_darray PIO_write_darray
-!! @brief The overloaded PIO_write_darray writes a distributed array to disk.
+!! The overloaded PIO_write_darray writes a distributed array to disk.
 !<
   interface PIO_write_darray
 ! TYPE real,int,double
@@ -31,7 +31,7 @@ module piodarray
 
 !>
 !! @defgroup PIO_read_darray PIO_read_darray
-!! @brief The overloaded PIO_read_darray function reads a distributed array from disk.
+!! The overloaded PIO_read_darray function reads a distributed array from disk.
 !<
   interface PIO_read_darray
 ! TYPE real,int,double
@@ -106,17 +106,11 @@ contains
   end subroutine pio_set_buffer_size_limit
 
 ! TYPE real,int,double
-  !> 1D write_darray for type {TYPE}.
+  !> 1D write_darray for type {TYPE}. Writes a 2-d slab of TYPE to a
+  !! netcdf file.
+  !<
   subroutine write_darray_1d_cinterface_{TYPE} (File,varDesc,ioDesc, arraylen, array, iostat, fillval)
     use iso_c_binding
-    ! !DESCRIPTION:
-    !  Writes a 2-d slab of TYPE to a netcdf file.
-    !
-    ! !REVISION HISTORY:
-    !  same as module
-
-    ! !INPUT PARAMETERS:
-
     type (File_desc_t), intent(inout) :: &
          File                   ! file information
 
@@ -151,17 +145,9 @@ contains
   end subroutine write_darray_1d_cinterface_{TYPE}
 
 ! TYPE real,int,double
-  !> 1D write_darray_multi for type {TYPE}.
+  !> 1D write_darray_multi for type {TYPE}. Writes a 2-d slab of TYPE to a netcdf file.
   subroutine write_darray_multi_1d_cinterface_{TYPE} (File,varDesc,ioDesc,nvars,arraylen, array, iostat, fillval)
     use iso_c_binding
-    ! !DESCRIPTION:
-    !  Writes a 2-d slab of TYPE to a netcdf file.
-    !
-    ! !REVISION HISTORY:
-    !  same as module
-
-    ! !INPUT PARAMETERS:
-
     type (File_desc_t), intent(inout) :: &
          File                   ! file information
 
@@ -199,27 +185,19 @@ contains
   end subroutine write_darray_multi_1d_cinterface_{TYPE}
 
 ! TYPE real,int,double
-!>
-!! @public
-!! @ingroup PIO_write_darray
-!! @brief Writes a 1D array of type {TYPE}.
-!! @details
-!! @param File    \ref file_desc_t
-!! @param varDesc \ref var_desc_t
-!! @param ioDesc  \ref io_desc_t
-!! @param array  : The data to be written
-!! @param iostat : The status returned from this routine (see \ref PIO_seterrorhandling for details)
-!! @param fillval : An optional fill value to fill holes in the data written
-!<
+  !>
+  !! @ingroup PIO_write_darray
+  !! Writes a 1D array of type {TYPE}. Writes a block of TYPE to a netcdf file.
+  !!
+  !! @param File    \ref file_desc_t
+  !! @param varDesc \ref var_desc_t
+  !! @param ioDesc  \ref io_desc_t
+  !! @param array  : The data to be written
+  !! @param iostat : The status returned from this routine (see \ref PIO_seterrorhandling for details)
+  !! @param fillval : An optional fill value to fill holes in the data written
+  !! @author Jim Edwards
+  !<
   subroutine write_darray_multi_1d_{TYPE} (File,varDesc,ioDesc, array, iostat, fillval)
-    ! !DESCRIPTION:
-    !  Writes a block of TYPE to a netcdf file.
-    !
-    ! !REVISION HISTORY:
-    !  same as module
-
-    ! !INPUT PARAMETERS:
-
     type (File_desc_t), intent(inout) :: &
          File                   ! file information
 
@@ -245,15 +223,8 @@ contains
   end subroutine write_darray_multi_1d_{TYPE}
 
 ! TYPE real,int,double
+  !> Writes a block of TYPE to a netcdf file.
   subroutine write_darray_1d_{TYPE} (File,varDesc,ioDesc, array, iostat, fillval)
-    ! !DESCRIPTION:
-    !  Writes a block of TYPE to a netcdf file.
-    !
-    ! !REVISION HISTORY:
-    !  same as module
-
-    ! !INPUT PARAMETERS:
-
     type (File_desc_t), intent(inout) :: &
          File                   ! file information
 
@@ -277,21 +248,19 @@ contains
 
 ! TYPE real,int,double
 ! DIMS 2,3,4,5,6,7
-!>
-!! @public
-!! @ingroup PIO_write_darray
-!! @brief Writes a {DIMS}D array of type {TYPE}.
-!! @details
-!! @param File @ref file_desc_t
-!! @param varDesc @ref var_desc_t
-!! @param ioDesc  @ref io_desc_t
-!! @param array  : The data to be written
-!! @param iostat : The status returned from this routine (see \ref PIO_seterrorhandling for details)
-!! @param fillval : An optional fill value to fill holes in the data written
-!<
+  !>
+  !! @ingroup PIO_write_darray
+  !! Writes a {DIMS}D array of type {TYPE}.
+  !!
+  !! @param File @ref file_desc_t
+  !! @param varDesc @ref var_desc_t
+  !! @param ioDesc  @ref io_desc_t
+  !! @param array  : The data to be written
+  !! @param iostat : The status returned from this routine (see \ref PIO_seterrorhandling for details)
+  !! @param fillval : An optional fill value to fill holes in the data written
+  !! @author Jim Edwards
+  !<
   subroutine write_darray_{DIMS}d_{TYPE} (File,varDesc,ioDesc, array, iostat, fillval)
-    ! !INPUT PARAMETERS:
-
     type (File_desc_t), intent(inout) :: &
          File                   ! file information
 
@@ -332,27 +301,20 @@ contains
 
 ! TYPE real,int,double
 ! DIMS 1,2,3,4,5,6,7
-!>
-!! @public
-!! @ingroup PIO_read_darray
-!! @brief Read distributed array of type {TYPE} from a netCDF variable of {DIMS} dimension(s).
-!! @details
-!! @param File @ref file_desc_t
-!! @param varDesc @ref var_desc_t
-!! @param ioDesc @ref io_desc_t
-!! @param array  : The read data
-!! @param iostat : The status returned from this routine (see \ref PIO_seterrorhandling for details)
-!<
+  !>
+  !! @ingroup PIO_read_darray
+  !! Read distributed array of type {TYPE} from a netCDF variable of {DIMS} dimension(s).
+  !!
+  !! @param File @ref file_desc_t
+  !! @param varDesc @ref var_desc_t
+  !! @param ioDesc @ref io_desc_t
+  !! @param array  : The read data
+  !! @param iostat : The status returned from this routine (see \ref PIO_seterrorhandling for details)
+  !! @author Jim Edwards
+  !<
   subroutine read_darray_{DIMS}d_{TYPE} (File,varDesc, ioDesc, array, iostat)
     use iso_c_binding
 !    use ifcore, only: tracebackqq
-    ! !DESCRIPTION:
-    !  Reads a slab of TYPE from a netcdf file.
-    !
-    ! !REVISION HISTORY:
-    !  same as module
-
-    ! !INPUT PARAMETERS:
 
     type (File_desc_t), intent(inout) :: &
          File                   ! file information
@@ -377,13 +339,6 @@ contains
   !> Internal read_darray for type {TYPE}
   subroutine read_darray_internal_{TYPE} (ncid, varid, ioid, alen, array, iostat)
     use iso_c_binding
-    ! !DESCRIPTION:
-    !  Reads a slab of TYPE from a netcdf file.
-    !
-    ! !REVISION HISTORY:
-    !  same as module
-
-    ! !INPUT PARAMETERS:
     integer, intent(in) :: ncid, varid, ioid
     integer(C_SIZE_T), intent(in) :: alen