diff --git a/examples/c/example2.c b/examples/c/example2.c index fc05e61aa8..93283ba53b 100644 --- a/examples/c/example2.c +++ b/examples/c/example2.c @@ -43,14 +43,11 @@ * are using three-dimensional data. */ #define NDIM 3 -/** The length of our sample data along each dimension. There will be - * a total of 16 integers in each timestep of our data, and - * responsibilty for writing and reading them will be spread between - * all the processors used to run this example. */ -/**@{*/ +/** Length along x dimension. */ #define X_DIM_LEN 20 + +/** Length along y dimension. */ #define Y_DIM_LEN 30 -/**@}*/ /** The number of timesteps of data to write. */ #define NUM_TIMESTEPS 6 @@ -128,21 +125,30 @@ PIO_Offset chunksize[NDIM] = {2, X_DIM_LEN/2, Y_DIM_LEN/2}; /**@}*/ #endif /* HAVE_MPE */ -/** Some error codes for when things go wrong. */ -/**@{*/ +/** File error. */ #define ERR_FILE 1 +/** File error. */ #define ERR_DUMB 2 +/** Argument error. */ #define ERR_ARG 3 +/** MPI error. */ #define ERR_MPI 4 +/** MPI Type error. */ #define ERR_MPITYPE 5 +/** Logging error. */ #define ERR_LOGGING 6 +/** Update error. */ #define ERR_UPDATE 7 +/** Calculation error. */ #define ERR_CALC 8 +/** Count error. */ #define ERR_COUNT 9 +/** Write error. */ #define ERR_WRITE 10 +/** Swap error. */ #define ERR_SWAP 11 +/** Init error. */ #define ERR_INIT 12 -/**@}*/ /** This will set up the MPE logging event numbers. * diff --git a/src/clib/pio_nc.c b/src/clib/pio_nc.c index 64c76e1c04..7c49d5880f 100644 --- a/src/clib/pio_nc.c +++ b/src/clib/pio_nc.c @@ -1283,7 +1283,6 @@ PIOc_inq_att_eh(int ncid, int varid, const char *name, int eh, * * @param ncid the ncid of the open file, obtained from * PIOc_openfile() or PIOc_createfile(). - * @param varid the variable ID. * @param varid the variable ID or NC_GLOBAL. * @param name name of the attribute. * @param xtypep a pointer that will get the type of the attribute. diff --git a/src/flib/Makefile.am b/src/flib/Makefile.am index 7862825f28..93d816e935 100644 --- a/src/flib/Makefile.am +++ b/src/flib/Makefile.am @@ -114,38 +114,50 @@ pionfatt_mod_2.f90: pionfatt_mod.f90 sed -e '/^ integer function put_att_desc_real.*/i !> put real att' \ -e '/^ integer function put_att_desc_double.*/i !> put double att' \ -e '/^ integer function put_att_desc_int.*/i !> put int att' \ + -e '/^ integer function put_att_desc_short.*/i !> put short att' \ -e '/^ integer function put_att_vid_text.*/i !> put text att' \ -e '/^ integer function put_att_vid_real.*/i !> put real att' \ -e '/^ integer function put_att_vid_double.*/i !> put double att' \ -e '/^ integer function put_att_vid_int.*/i !> put int att' \ + -e '/^ integer function put_att_vid_short.*/i !> put int att' \ -e '/^ integer function put_att_id_int.*/i !> put int att' \ + -e '/^ integer function put_att_id_short.*/i !> put short att' \ -e '/^ integer function put_att_id_real.*/i !> put att' \ -e '/^ integer function put_att_id_double.*/i !> put att' \ -e '/^ integer function put_att_id_text.*/i !> put att' \ + -e '/^ integer function put_att_id_short.*/i !> put att' \ -e '/^ integer function put_att_1d_id_text.*/i !> put att' \ -e '/^ integer function put_att_1d_id_text_internal.*/i !> put att' \ + -e '/^ integer function put_att_1d_id_short_internal.*/i !> put att' \ -e '/^ integer function get_att_id_text.*/i !> get att' \ -e '/^ integer function put_att_1d_id_internal_real.*/i !> att' \ -e '/^ integer function put_att_1d_id_internal_double.*/i !> att' \ -e '/^ integer function put_att_1d_id_internal_int.*/i !> att' \ + -e '/^ integer function put_att_1d_id_internal_short.*/i !> att' \ -e '/^ integer function put_att_1d_vid_text.*/i !> att' \ -e '/^ integer function put_att_1d_vid_real.*/i !> att' \ -e '/^ integer function put_att_1d_vid_double.*/i !> att' \ -e '/^ integer function put_att_1d_vid_int.*/i !> att' \ + -e '/^ integer function put_att_1d_vid_short.*/i !> att' \ -e '/^ integer function get_att_desc_real.*/i !> att' \ -e '/^ integer function get_att_desc_double.*/i !> att' \ -e '/^ integer function get_att_desc_int.*/i !> att' \ + -e '/^ integer function get_att_desc_short.*/i !> att' \ -e '/^ integer function get_att_desc_1d_real.*/i !> att' \ + -e '/^ integer function get_att_desc_1d_short.*/i !> att' \ -e '/^ integer function get_att_desc_1d_double.*/i !> att' \ -e '/^ integer function get_att_id_real.*/i !> att' \ -e '/^ integer function get_att_id_double.*/i !> att' \ + -e '/^ integer function get_att_id_short.*/i !> att' \ -e '/^ integer function get_att_text.*/i !> att' \ -e '/^ integer function get_att_real.*/i !> att' \ -e '/^ integer function get_att_double.*/i !> att' \ -e '/^ integer function get_att_int.*/i !> att' \ + -e '/^ integer function get_att_short.*/i !> att' \ -e '/^ integer function get_att_1d_id_real.*/i !> att' \ -e '/^ integer function get_att_1d_id_int.*/i !> att' \ -e '/^ integer function get_att_1d_id_double.*/i !> att' \ + -e '/^ integer function get_att_1d_id_short.*/i !> att' \ -e '/^ integer(C_INT) function PIOc_get_att_double.*/i !> att' \ -e '/^ integer function pioc_get_att_float.*/i !> att' \ -e '/^ integer function pioc_get_att_int.*/i !> att' \ @@ -159,12 +171,16 @@ pionfget_mod_2.f90: pionfget_mod.f90 sed -e '/^ integer function get_var1_id_real.*/i !> var' \ -e '/^ integer function get_var1_id_double.*/i !> var' \ -e '/^ integer function get_var1_id_text.*/i !> var' \ + -e '/^ integer function get_var1_id_short.*/i !> var' \ -e '/^ integer function get_var_0d_real.*/i !> var' \ -e '/^ integer function get_var_0d_double.*/i !> var' \ + -e '/^ integer function get_var_0d_short.*/i !> var' \ -e '/^ integer function get_var_1d_text.*/i !> var' \ + -e '/^ integer function get_var_1d_short.*/i !> var' \ -e '/^ integer function get_vara_real_internal.*/i !> var' \ -e '/^ integer function get_vara_double_internal.*/i !> var' \ -e '/^ integer function get_vara_text_internal.*/i !> var' \ + -e '/^ integer function get_vara_short_internal.*/i !> var' \ -e '/^ integer function get_var_1d_int.*/i !> var' \ $< > $@ endif diff --git a/src/flib/pio_types.F90 b/src/flib/pio_types.F90 index a8d453edc6..970c2c8340 100644 --- a/src/flib/pio_types.F90 +++ b/src/flib/pio_types.F90 @@ -153,8 +153,8 @@ module pio_types double precision, public, parameter :: PIO_FILL_DOUBLE = nf_fill_double; !< double fill value enum, bind(c) - enumerator :: PIO_rearr_comm_p2p = 0 - enumerator :: PIO_rearr_comm_coll + enumerator :: PIO_rearr_comm_p2p = 0 !< do point-to-point communications using mpi send and recv calls. + enumerator :: PIO_rearr_comm_coll !< use the MPI_ALLTOALLW function of the mpi library end enum !> diff --git a/src/flib/piolib_mod.F90 b/src/flib/piolib_mod.F90 index 9a28de9d7b..21c174355f 100644 --- a/src/flib/piolib_mod.F90 +++ b/src/flib/piolib_mod.F90 @@ -403,7 +403,6 @@ end subroutine setdebuglevel !! @param file @copydoc file_desc_t !! @param method error handling method !! @param oldmethod old error handling method - !! @copydoc PIO_error_method !! @author Jim Edwards !< subroutine seterrorhandlingfile(file, method, oldmethod) @@ -1245,7 +1244,7 @@ end subroutine PIO_set_hint !! Finalizes an IO System. This is a collective call. !! !! @param iosystem @copydoc io_desc_t - !! @retval ierr @copydoc error_return + !! @param ierr @copydoc error_return !! @author Jim Edwards !< subroutine finalize(iosystem,ierr) diff --git a/src/flib/pionfput_mod.F90.in b/src/flib/pionfput_mod.F90.in index fd2231305d..727c7d0dbc 100644 --- a/src/flib/pionfput_mod.F90.in +++ b/src/flib/pionfput_mod.F90.in @@ -171,7 +171,6 @@ contains !! @brief Writes a netCDF scalar variable. !! @details !! @param File @copydoc file_desc_t -!! @param File : A file handle returne from \ref PIO_openfile or \ref PIO_createfile. !! @param varid : The netcdf variable identifier !! @param ival : The value for the netcdf variable !! @retval ierr @copydoc error_return @@ -207,7 +206,6 @@ contains !! @brief Writes text data to netcdf variable. !! @details !! @param File @copydoc file_desc_t -!! @param File : A file handle returne from \ref PIO_openfile or \ref PIO_createfile. !! @param varid : The netcdf variable identifier !! @param ival : The value for the netcdf metadata !! @retval ierr @copydoc error_return @@ -273,7 +271,6 @@ contains !! @brief Write {TYPE} data to a netCDF varaible of {DIMS} dimension(s). !! @details !! @param File @copydoc file_desc_t -!! @param File : A file handle returne from \ref PIO_openfile or \ref PIO_createfile. !! @param varid : The netcdf variable identifier !! @param ival : The value for the netcdf metadata !! @retval ierr @copydoc error_return @@ -299,7 +296,6 @@ contains !! @brief Writes {TYPE} data to a netCDF scalar variable. !! @details !! @param File @copydoc file_desc_t -!! @param File : A file handle returne from \ref PIO_openfile or \ref PIO_createfile. !! @param varid : The netcdf variable identifier !! @param ival : The value for the netcdf metadata !! @retval ierr @copydoc error_return