diff options
author | 2020-01-07 15:52:36 -0800 | |
---|---|---|
committer | 2020-01-07 15:52:36 -0800 | |
commit | bed6fa6939db176d4f5987db8792e793951932e5 (patch) | |
tree | 293a28b0217d0628e2db8c2a8729b85e3a15ec2c /Source/Particles/Sorting/SortingUtils.H | |
parent | 03043ce368c8c1dbe081c52126e6a61e94b42edb (diff) | |
parent | 8ea11195d34d61e9353da2f00ee081e6d751149b (diff) | |
download | WarpX-bed6fa6939db176d4f5987db8792e793951932e5.tar.gz WarpX-bed6fa6939db176d4f5987db8792e793951932e5.tar.zst WarpX-bed6fa6939db176d4f5987db8792e793951932e5.zip |
Merge pull request #573 from MaxThevenet/reformat_doxygen
Make comments in header files Doxygen-readable
Diffstat (limited to 'Source/Particles/Sorting/SortingUtils.H')
-rw-r--r-- | Source/Particles/Sorting/SortingUtils.H | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Source/Particles/Sorting/SortingUtils.H b/Source/Particles/Sorting/SortingUtils.H index 80eaaf9cb..35bc059aa 100644 --- a/Source/Particles/Sorting/SortingUtils.H +++ b/Source/Particles/Sorting/SortingUtils.H @@ -8,7 +8,7 @@ #include <thrust/distance.h> #endif -/* \brief Fill the elements of the input vector with consecutive integer, +/** \brief Fill the elements of the input vector with consecutive integer, * starting from 0 * * \param[inout] v Vector of integers, to be filled by this routine @@ -24,7 +24,7 @@ void fillWithConsecutiveIntegers( amrex::Gpu::DeviceVector<long>& v ) #endif } -/* \brief Find the indices that would reorder the elements of `predicate` +/** \brief Find the indices that would reorder the elements of `predicate` * so that the elements with non-zero value precede the other elements * * \param[in, out] index_begin Point to the beginning of the vector which is @@ -56,7 +56,7 @@ ForwardIterator stablePartition(ForwardIterator const index_begin, return sep; } -/* \brief Return the number of elements between `first` and `last` +/** \brief Return the number of elements between `first` and `last` * * \param[in] fist Points to a position in a vector * \param[in] last Points to another position in a vector @@ -74,7 +74,7 @@ int iteratorDistance(ForwardIterator const first, #endif } -/* \brief Functor that fills the elements of the particle array `inexflag` +/** \brief Functor that fills the elements of the particle array `inexflag` * with the value of the spatial array `bmasks`, at the corresponding particle position. * * \param[in] pti Contains information on the particle positions @@ -124,7 +124,7 @@ class fillBufferFlag amrex::Array4<int const> m_buffer_mask; }; -/* \brief Functor that fills the elements of the particle array `inexflag` +/** \brief Functor that fills the elements of the particle array `inexflag` * with the value of the spatial array `bmasks`, at the corresponding particle position. * * Contrary to `fillBufferFlag`, here this is done only for the particles that @@ -186,7 +186,7 @@ class fillBufferFlagRemainingParticles long const* m_indices_ptr; }; -/* \brief Functor that copies the elements of `src` into `dst`, +/** \brief Functor that copies the elements of `src` into `dst`, * while reordering them according to `indices` * * \param[in] src Source vector |