build/fft: extending line width for more compact header with comment apis
@@ -1375,9 +1375,10 @@ typedef enum {
// TC : primitive data type (complex)
#define LIQUID_FFT_DEFINE_API(FFT,T,TC) \
\
+/* Fast Fourier Transform (FFT) and inverse (plan) object */ \
typedef struct FFT(plan_s) * FFT(plan); \
\
-/* create regular complex one-dimensional transform */ \
+/* Create regular complex one-dimensional transform */ \
/* _n : transform size */ \
/* _x : pointer to input array [size: _n x 1] */ \
/* _y : pointer to output array [size: _n x 1] */ \
@@ -1389,7 +1390,7 @@ FFT(plan) FFT(_create_plan)(unsigned int _n, \
int _dir, \
int _flags); \
\
-/* create real-to-real transform */ \
+/* Create real-to-real one-dimensional transform */ \
/* _n : transform size */ \
/* _x : pointer to input array [size: _n x 1] */ \
/* _y : pointer to output array [size: _n x 1] */ \
@@ -1401,18 +1402,18 @@ FFT(plan) FFT(_create_plan_r2r_1d)(unsigned int _n, \
int _type, \
int _flags); \
\
-/* destroy transform */ \
+/* Destroy transform and free all internally-allocated memory */ \
void FFT(_destroy_plan)(FFT(plan) _p); \
\
-/* print transform plan and internal strategy */ \
+/* Print transform plan and internal strategy to stdout. This includes */ \
+/* information on the strategy for computing large transforms with many */ \
+/* prime factors or with large prime factors. */ \
void FFT(_print_plan)(FFT(plan) _p); \
\
-/* run the transform */ \
+/* Run the transform */ \
void FFT(_execute)(FFT(plan) _p); \
\
-/* object-independent methods */ \
- \
-/* perform n-point FFT allocating plan internally */ \
+/* Perform n-point FFT allocating plan internally */ \
/* _nfft : fft size */ \
/* _x : input array [size: _nfft x 1] */ \
/* _y : output array [size: _nfft x 1] */ \
@@ -1424,7 +1425,7 @@ void FFT(_run)(unsigned int _n, \
int _dir, \
int _flags); \
\
-/* perform n-point real FFT allocating plan internally */ \
+/* Perform n-point real one-dimensional FFT allocating plan internally */ \
/* _nfft : fft size */ \
/* _x : input array [size: _nfft x 1] */ \
/* _y : output array [size: _nfft x 1] */ \
@@ -1436,7 +1437,9 @@ void FFT(_r2r_1d_run)(unsigned int _n, \
int _type, \
int _flags); \
\
-/* perform _n-point fft shift */ \
+/* Perform _n-point fft shift */ \
+/* _x : input array [size: _n x 1] */ \
+/* _n : input array size */ \
void FFT(_shift)(TC * _x, \
unsigned int _n); \
