more doxygen fixes (Vedran Miletić)

svn-origin-rev: 14230

Author: vondele

src/acc/acc_device.F

@@ -40,8 +40,8 @@ END FUNCTION acc_set_active_device_cu
 CONTAINS
 
 ! *****************************************************************************
-!> \brief ...
-!> \retval n ...
+!> \brief Get number of accelerator devices
+!> \retval n number of accelerator devices
 ! *****************************************************************************
   FUNCTION acc_get_ndevices() RESULT(n)
     INTEGER                                  :: n
@@ -59,8 +59,8 @@ END FUNCTION acc_get_ndevices
 
 
 ! *****************************************************************************
-!> \brief ...
-!> \param dev_id ...
+!> \brief Set active accelerator device
+!> \param dev_id device ID
 ! *****************************************************************************
   SUBROUTINE acc_set_active_device(dev_id)
     INTEGER :: dev_id

src/acc/acc_devmem.F

@@ -164,11 +164,11 @@ END FUNCTION dc_memcpy_d2d_cu
 
 ! *****************************************************************************
 !> \brief Ensures that given devmem has at least the requested size.
-!> \param this ...
-!> \param stream on which zeroing and memcopying is performed
-!> \param requested_size_in_bytes ...
-!> \param nocopy if after growin old content should NOT be copied over. default:false.
-!> \param zero_pad if after growing the new memory should be zeroed. default: false.
+!> \param[in,out] this device memory
+!> \param[in] stream on which zeroing and memcopying is performed
+!> \param[in] requested_size_in_bytes requested size in bytes
+!> \param[in] (optional) nocopy if after growin old content should NOT be copied over. Default: false.
+!> \param[in] (optional) zero_pad if after growing the new memory should be zeroed. Default: false.
 !> \author Ole Schuett
 ! *****************************************************************************
   SUBROUTINE acc_devmem_ensure_size_bytes(this, stream, requested_size_in_bytes, nocopy, zero_pad)
@@ -227,8 +227,8 @@ END SUBROUTINE acc_devmem_ensure_size_bytes
 
 ! *****************************************************************************
 !> \brief Returns a logical, which indicates if the given devmem is allocated.
-!> \param this ...
-!> \retval res ...
+!> \param[in] this device memory
+!> \retval res true if device memory is allocated, false otherwise
 !> \author  Ole Schuett
 ! *****************************************************************************
   FUNCTION acc_devmem_allocated(this) RESULT(res)
@@ -241,8 +241,8 @@ END FUNCTION acc_devmem_allocated
 
 ! *****************************************************************************
 !> \brief Returns size of given devmem in terms of item count (not bytes!)
-!> \param this ...
-!> \retval res ...
+!> \param[in] this device memory
+!> \retval res size of device memory (item count)
 !> \author  Ole Schuett
 ! *****************************************************************************
   FUNCTION acc_devmem_size_in_bytes(this) RESULT(res)
@@ -256,9 +256,9 @@ END FUNCTION acc_devmem_size_in_bytes
 
 
 ! *****************************************************************************
-!> \brief Returns C-pointer to data of give devmem.
-!> \param this ...
-!> \retval res ...
+!> \brief Returns C-pointer to data of given devmem.
+!> \param[in] this device memory
+!> \retval res false (accelerator support is not enabled)
 !> \author  Ole Schuett
 ! *****************************************************************************
 #if ! defined (__ACC)
@@ -270,9 +270,10 @@ FUNCTION acc_devmem_cptr(this) RESULT(res)
   END FUNCTION acc_devmem_cptr
 #else
 ! *****************************************************************************
-!> \brief ...
-!> \param this ...
-!> \retval res ...
+!> \brief Returns C-pointer to data of given devmem.
+!> \param[in] this device memory
+!> \retval res C-pointer to data of given devmem
+!> \author  Ole Schuett
 ! *****************************************************************************
   FUNCTION acc_devmem_cptr(this) RESULT(res)
     TYPE(acc_devmem_type), INTENT(IN)        :: this
@@ -286,8 +287,8 @@ END FUNCTION acc_devmem_cptr
 
 ! *****************************************************************************
 !> \brief Fortran-wrapper for cudaMemGetInfo.
-!> \param free ...
-!> \param avail ...
+!> \param[out] free free device memory
+!> \param[out] avail available device memory
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE acc_devmem_info(free, avail)
@@ -305,8 +306,8 @@ END SUBROUTINE acc_devmem_info
 
 ! *****************************************************************************
 !> \brief Allocates a given devmem.
-!> \param this ...
-!> \param size_in_bytes ...
+!> \param[in,out] this device memory
+!> \param[in] size_in_bytes size in bytes
 !> \author  Ole Schuett
 ! *****************************************************************************
   SUBROUTINE acc_devmem_allocate_bytes(this, size_in_bytes)
@@ -333,7 +334,7 @@ END SUBROUTINE acc_devmem_allocate_bytes
 
 ! *****************************************************************************
 !> \brief Deallocates a given devmem.
-!> \param this ...
+!> \param[in,out] this device memory
 !> \author  Ole Schuett
 ! *****************************************************************************
   SUBROUTINE acc_devmem_deallocate(this)
@@ -361,10 +362,10 @@ END SUBROUTINE acc_devmem_deallocate
 
 ! *****************************************************************************
 !> \brief Sets entries in given devmem to zero, asynchronously.
-!> \param this ...
-!> \param first_byte begin of region to zero, defaults to 1 if not given.
-!> \param last_byte end of region to zero, defaults to size if not given.
-!> \param stream on which zeroing is performed.
+!> \param[in,out] this device memory
+!> \param[in] (optional) first_byte begin of region to zero, defaults to 1 if not given.
+!> \param[in] (optional) last_byte end of region to zero, defaults to size if not given.
+!> \param[in] stream stream on which zeroing is performed.
 !> \author  Ole Schuett
 ! *****************************************************************************
   SUBROUTINE acc_devmem_setzero_bytes(this, first_byte, last_byte, stream)
@@ -400,10 +401,10 @@ END SUBROUTINE acc_devmem_setzero_bytes
 
 ! *****************************************************************************
 !> \brief Helper-routine performing actuall host2dev transfers.
-!> \param this ...
-!> \param hostmem_cptr ...
-!> \param n_bytes ...
-!> \param stream ...
+!> \param[in] this device memory
+!> \param hostmem_cptr host memory
+!> \param[in] n_bytes number of bytes
+!> \param[in] stream stream used for memory transfer
 !> \author  Ole Schuett
 ! *****************************************************************************
 #if defined (__ACC)
@@ -433,10 +434,10 @@ END SUBROUTINE host2dev_raw
 
 ! *****************************************************************************
 !> \brief Helper-routine performing actual dev2host transfers.
-!> \param this ...
-!> \param hostmem_cptr ...
-!> \param n_bytes ...
-!> \param stream ...
+!> \param[in] this device memory
+!> \param hostmem_cptr host memory
+!> \param[in] n_bytes number of bytes
+!> \param[in] stream stream used for memory transfer
 !> \author  Ole Schuett
 ! *****************************************************************************
 #if defined (__ACC)

src/acc/acc_devmem__nametype_.template

@@ -1,8 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
-!> \param this ...
-!> \param hostmem ...
-!> \param stream ...
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_[nametype]_1D(this, hostmem, stream)
@@ -20,9 +20,9 @@
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
-!> \param this ...
-!> \param hostmem ...
-!> \param stream ...
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_[nametype]_2D(this, hostmem, stream)
@@ -40,9 +40,9 @@
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
-!> \param this ...
-!> \param hostmem ...
-!> \param stream ...
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_[nametype]_1D(this, hostmem, stream)

src/acc/acc_devmem_c4.f90

@@ -1,5 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_c4_1D(this, hostmem, stream)
@@ -17,6 +20,9 @@ END SUBROUTINE host2dev_c4_1D
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_c4_2D(this, hostmem, stream)
@@ -34,6 +40,9 @@ END SUBROUTINE host2dev_c4_2D
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_c4_1D(this, hostmem, stream)

src/acc/acc_devmem_c8.f90

@@ -1,5 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_c8_1D(this, hostmem, stream)
@@ -17,6 +20,9 @@ END SUBROUTINE host2dev_c8_1D
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_c8_2D(this, hostmem, stream)
@@ -34,6 +40,9 @@ END SUBROUTINE host2dev_c8_2D
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_c8_1D(this, hostmem, stream)

src/acc/acc_devmem_i4.f90

@@ -1,5 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_i4_1D(this, hostmem, stream)
@@ -17,6 +20,9 @@ END SUBROUTINE host2dev_i4_1D
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_i4_2D(this, hostmem, stream)
@@ -34,6 +40,9 @@ END SUBROUTINE host2dev_i4_2D
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_i4_1D(this, hostmem, stream)

src/acc/acc_devmem_i8.f90

@@ -1,5 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_i8_1D(this, hostmem, stream)
@@ -17,6 +20,9 @@ END SUBROUTINE host2dev_i8_1D
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_i8_2D(this, hostmem, stream)
@@ -34,6 +40,9 @@ END SUBROUTINE host2dev_i8_2D
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_i8_1D(this, hostmem, stream)

src/acc/acc_devmem_r4.f90

@@ -1,5 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_r4_1D(this, hostmem, stream)
@@ -17,6 +20,9 @@ END SUBROUTINE host2dev_r4_1D
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_r4_2D(this, hostmem, stream)
@@ -34,6 +40,9 @@ END SUBROUTINE host2dev_r4_2D
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_r4_1D(this, hostmem, stream)

src/acc/acc_devmem_r8.f90

@@ -1,5 +1,8 @@
 ! *****************************************************************************
 !> \brief Transfers 1D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_r8_1D(this, hostmem, stream)
@@ -17,6 +20,9 @@ END SUBROUTINE host2dev_r8_1D
 
 ! *****************************************************************************
 !> \brief Transfers 2D fortran-array from host to cuda devmem.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE host2dev_r8_2D(this, hostmem, stream)
@@ -34,6 +40,9 @@ END SUBROUTINE host2dev_r8_2D
 
 ! *****************************************************************************
 !> \brief Transfers cuda devmem to 1D fortran-array.
+!> \param[in] this device memory
+!> \param hostmem host memory
+!> \param[in] stream stream
 !> \author  Ole Schuett
 ! *****************************************************************************
  SUBROUTINE dev2host_r8_1D(this, hostmem, stream)