From f1b72e1b39929eb2695772ccd5a9b50198c740b6 Mon Sep 17 00:00:00 2001 From: Ed Hartnett Date: Wed, 29 May 2019 09:31:12 -0600 Subject: [PATCH] fortran documentation changes --- Makefile.am | 2 ++ doc/source/api.txt | 2 +- src/flib/piolib_mod.F90 | 34 ++++++++++++++++------------------ 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Makefile.am b/Makefile.am index d844a527697..e8ee3b0568d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -13,3 +13,5 @@ endif SUBDIRS = src tests examples ${DOC} scripts EXTRA_DIST = CMakeLists.txt set_flags.am COPYRIGHT + +CLEANFILES = docs/* docs diff --git a/doc/source/api.txt b/doc/source/api.txt index 72420cffb7e..bad738c4718 100644 --- a/doc/source/api.txt +++ b/doc/source/api.txt @@ -16,7 +16,7 @@ - \ref PIO_read_darray - \ref PIO_write_darray \section utility Utility routines - - \ref PIO_set_hint_grp + - \ref PIO_set_hint - \ref PIO_setframe - \ref PIO_advanceframe - \ref PIO_setdebuglevel diff --git a/src/flib/piolib_mod.F90 b/src/flib/piolib_mod.F90 index fd267dcd00e..6998694551f 100644 --- a/src/flib/piolib_mod.F90 +++ b/src/flib/piolib_mod.F90 @@ -913,15 +913,15 @@ end subroutine init_intracom !! ignored. This variation of PIO_init sets up a distinct set of !! tasks to handle IO, these tasks do not return from this !! call. Instead they go to an internal loop and wait to receive - !! further instructions from the computational tasks + !! further instructions from the computational tasks. !! !! @param component_count The number of computational components to - !! associate with this IO component + !! associate with this IO component. !! @param peer_comm The communicator from which all other - !! communicator arguments are derived + !! communicator arguments are derived. !! @param comp_comms The computational communicator for each of the - !! computational components - !! @param io_comm The io communicator + !! computational components. + !! @param io_comm The io communicator. !! @param iosystem a derived type which can be used in subsequent !! pio operations (defined in PIO_types). !< @@ -1141,15 +1141,16 @@ subroutine init_intercom(component_count, peer_comm, comp_comms, io_comm, iosyst end subroutine init_intercom !> - !! @defgroup PIO_set_hint_grp PIO_set_hint + !! @defgroup PIO_set_hint PIO_set_hint - !> Set file system hints using mpi_info_set. This is a collective - !> call which expects the following parameters: + !> @ingroup PIO_set_hint + !! Set file system hints using mpi_info_set. This is a collective + !! call. !! !! @param iosystem @copydoc io_desc_t - !! @param hint the string name of the hint to define - !! @param hintval the string value to set the hint to - !! @retval ierr @copydoc error_return + !! @param hint the string name of the hint to define + !! @param hintval the string value to set the hint to + !! @retval ierr @copydoc error_return subroutine PIO_set_hint(iosystem, hint, hintval) type (iosystem_desc_t), intent(inout) :: iosystem ! io descriptor to initalize character(len=*), intent(in) :: hint, hintval @@ -1165,19 +1166,16 @@ integer(C_INT) function PIOc_set_hint(iosysid, key, val) & end function PIOc_set_hint end interface - ierr = PIOc_set_hint(iosystem%iosysid, hint, hintval) - end subroutine PIO_set_hint - !> !! @ingroup PIO_finalize - !! @brief finalizes the pio subsystem. - !! @details This is a collective call which expects the following parameters - !! @param iosystem : @copydoc io_desc_t - !! @retval ierr @copydoc error_return + !! Finalizes an IO System. This is a collective call. + !! + !! @param iosystem @copydoc io_desc_t + !! @retval ierr @copydoc error_return !< subroutine finalize(iosystem,ierr) type (iosystem_desc_t), intent(inout) :: iosystem