build/autocorr: extending line width for more compact header with comment apis
@@ -2183,33 +2183,39 @@ void liquid_levinson(float * _r,
// TI : input data type
#define LIQUID_AUTOCORR_DEFINE_API(AUTOCORR,TO,TC,TI) \
\
+/* Computes auto-correlation with a fixed lag on input signals */ \
typedef struct AUTOCORR(_s) * AUTOCORR(); \
\
-/* create auto-correlator object */ \
+/* Create auto-correlator object with a particular window length and */ \
+/* delay */ \
/* _window_size : size of the correlator window */ \
/* _delay : correlator delay [samples] */ \
AUTOCORR() AUTOCORR(_create)(unsigned int _window_size, \
unsigned int _delay); \
\
-/* destroy auto-correlator object, freeing internal memory */ \
+/* Destroy auto-correlator object, freeing internal memory */ \
void AUTOCORR(_destroy)(AUTOCORR() _q); \
\
-/* reset auto-correlator object's internals */ \
+/* Reset auto-correlator object's internals */ \
void AUTOCORR(_reset)(AUTOCORR() _q); \
\
-/* print auto-correlator parameters to stdout */ \
+/* Print auto-correlator parameters to stdout */ \
void AUTOCORR(_print)(AUTOCORR() _q); \
\
-/* push sample into auto-correlator object */ \
+/* Push sample into auto-correlator object */ \
+/* _q : auto-correlator object */ \
+/* _x : single input sample */ \
void AUTOCORR(_push)(AUTOCORR() _q, \
TI _x); \
\
-/* compute single auto-correlation output */ \
+/* Compute single auto-correlation output */ \
+/* _q : auto-correlator object */ \
+/* _rxx : auto-correlated output */ \
void AUTOCORR(_execute)(AUTOCORR() _q, \
TO * _rxx); \
\
-/* compute auto-correlation on block of samples; the input */ \
-/* and output arrays may have the same pointer */ \
+/* Compute auto-correlation on block of samples; the input and output */ \
+/* arrays may have the same pointer */ \
/* _q : auto-correlation object */ \
/* _x : input array [size: _n x 1] */ \
/* _n : number of input, output samples */ \
