Update docs

Author: vitalsong

include/dsplib/fft.h

@@ -5,41 +5,60 @@
 
 namespace dsplib {
 
-//base complex value FFT plan
+/**
+ * @brief FFT c2c base class
+ */
 class FftPlanC
 {
 public:
     virtual ~FftPlanC() = default;
+
     [[nodiscard]] virtual arr_cmplx solve(const arr_cmplx& x) const = 0;
-    virtual void solve(const cmplx_t* x, cmplx_t* y, int n) const {
+
+    [[deprecated]] virtual void solve(const cmplx_t* x, cmplx_t* y, int n) const {
         const auto r = this->solve(arr_cmplx(x, n));
         std::memcpy(y, r.data(), n * sizeof(cmplx_t));
     }
+
     [[nodiscard]] virtual int size() const noexcept = 0;
 };
 
-//base real value FFT plan
+/**
+ * @brief FFT r2c base class
+ */
 class FftPlanR
 {
 public:
     virtual ~FftPlanR() = default;
+
     [[nodiscard]] virtual arr_cmplx solve(const arr_real& x) const = 0;
-    virtual void solve(const real_t* x, cmplx_t* y, int n) const {
+
+    [[deprecated]] virtual void solve(const real_t* x, cmplx_t* y, int n) const {
         //TODO: use span
         const auto r = this->solve(arr_real(x, n));
         std::memcpy(y, r.data(), n * sizeof(cmplx_t));
     }
+
     [[nodiscard]] virtual int size() const noexcept = 0;
 };
 
+/**
+ * @param n FFT size
+ * @return c2c FFT plan
+ */
 std::shared_ptr<FftPlanC> fft_plan_c(int n);
+
+/**
+ * @param n FFT size
+ * @return r2c FFT plan
+ */
 std::shared_ptr<FftPlanR> fft_plan_r(int n);
 
-/*!
- * \brief Fast Fourier Transform (complex)
- * \details FFT for complex signal
- * \param arr Input array [N]
- * \return Result array [N]
+/**
+ * @brief Fast Fourier Transform (complex)
+ * @details FFT for complex signal
+ * @param arr Input array [N]
+ * @return Result array [N]
  */
 arr_cmplx fft(const arr_cmplx& x);
 

include/dsplib/ifft.h

@@ -8,34 +8,42 @@ namespace dsplib {
 
 using IfftPlanC = FftPlanC;
 
+/**
+ * @brief iFFT c2r base class
+ */
 class IfftPlanR
 {
 public:
     virtual ~IfftPlanR() = default;
     [[nodiscard]] virtual arr_real solve(const arr_cmplx& x) const = 0;
     [[nodiscard]] virtual int size() const noexcept = 0;
-
-    arr_real operator()(const arr_cmplx& x) const {
-        return this->solve(x);
-    }
 };
 
+/**
+ * @param n iFFT size
+ * @return c2c iFFT plan
+ */
 std::shared_ptr<IfftPlanC> ifft_plan_c(int n);
+
+/**
+ * @param n iFFT size
+ * @return c2r iFFT plan
+ */
 std::shared_ptr<IfftPlanR> ifft_plan_r(int n);
 
-/*!
- * \brief Inverse fourier transform
- * \details IFFT for complex signal
- * \param x Input array [N]
- * \return Result array [N]
+/**
+ * @brief Inverse fourier transform
+ * @details IFFT for complex signal
+ * @param x Input array [N]
+ * @return Result array [N]
  */
 arr_cmplx ifft(const arr_cmplx& x);
 
-/*!
- * \brief Inverse real fourier transform
- * \param x Input array [N or N/2+1]
- * \param n Transform size
- * \return Result array [N]
+/**
+ * @brief Inverse real fourier transform
+ * @param x Input array [N or N/2+1]
+ * @param n Transform size
+ * @return Result array [N]
  */
 arr_real irfft(const arr_cmplx& x, int n);