Cleanup docstrings for FFT APIs

yasahi-hpc · Nov 5, 2024 · 98017c2 · 98017c2
1 parent 29389f2
commit 98017c2
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/fft/src/KokkosFFT_Transform.hpp b/fft/src/KokkosFFT_Transform.hpp
@@ -326,7 +326,7 @@ void rfft2(const ExecutionSpace& exec_space, const InViewType& in,
   fft2(exec_space, in, out, norm, axes, s);
 }
 
-/// \brief Inverse of rfft2 with a given plan
+/// \brief Inverse of rfft2
 ///
 /// \param exec_space [in] Kokkos execution space
 /// \param in [in] Input data (complex)
@@ -364,7 +364,7 @@ void irfft2(const ExecutionSpace& exec_space, const InViewType& in,
 
 // ND FFT
 
-/// \brief N-dimensional FFT in forward direction with a given plan
+/// \brief N-dimensional FFT in forward direction
 ///
 /// \param exec_space [in] Kokkos execution space
 /// \param in [in] Input data (complex)
@@ -405,7 +405,7 @@ void fftn(
   plan.execute(in, out, norm);
 }
 
-/// \brief N-dimensional FFT in backward direction with a given plan
+/// \brief Inverse of fftn
 ///
 /// \param exec_space [in] Kokkos execution space
 /// \param in [in] Input data (complex)