From 77783b80a7925f719103a0d03f5669a01556ceb7 Mon Sep 17 00:00:00 2001
From: Drew Hubley <96780897+spectre-ns@users.noreply.github.com>
Date: Fri, 24 Nov 2023 08:09:22 -0400
Subject: [PATCH] Update fft.hpp

Added comments
---
 include/xtensor-signal/fft.hpp | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/include/xtensor-signal/fft.hpp b/include/xtensor-signal/fft.hpp
index d14f60d..2b5cd84 100644
--- a/include/xtensor-signal/fft.hpp
+++ b/include/xtensor-signal/fft.hpp
@@ -58,6 +58,12 @@ inline auto fft(E &&e) {
 }
 } // namespace detail
 
+/**
+* @breif 1D FFT of an Nd array along a specified axis
+* @param e an Nd expression to be transformed to the fourier domain
+* @param axis the axis along which to perform the 1D FFT
+* @return a transformed xarray of the specified precision
+*/
 template <class E,
           typename std::enable_if<
               xtl::is_complex<typename std::decay<E>::type::value_type>::value,
@@ -75,6 +81,12 @@ inline auto fft(E &&e, std::ptrdiff_t axis = -1) {
   return out;
 }
 
+/**
+* @breif 1D FFT of an Nd array along a specified axis
+* @param e an Nd expression to be transformed to the fourier domain
+* @param axis the axis along which to perform the 1D FFT
+* @return a transformed xarray of the specified precision
+*/
 template <class E,
           typename std::enable_if<
               !xtl::is_complex<typename std::decay<E>::type::value_type>::value,