build/symstream: extending line width for more compact header with comment apis
@@ -4844,34 +4844,37 @@ int detector_cccf_correlate(detector_cccf _q,
#define LIQUID_SYMSTREAM_DEFINE_API(SYMSTREAM,TO) \
\
+/* Symbol streaming generator object */ \
typedef struct SYMSTREAM(_s) * SYMSTREAM(); \
\
-/* create default symstream object */ \
-/* (LIQUID_RNYQUIST_ARKAISER, k=2, m=7, beta=0.3, QPSK) */ \
+/* Create symstream object with default parameters. */ \
+/* This is equivalent to invoking the create_linear() method */ \
+/* with _ftype=LIQUID_RNYQUIST_ARKAISER, _k=2, _m=7, _beta=0.3, and */ \
+/* with _ms=LIQUID_MODEM_QPSK */ \
SYMSTREAM() SYMSTREAM(_create)(void); \
\
-/* create symstream object with linear modulation */ \
+/* Create symstream object with linear modulation */ \
/* _ftype : filter type (e.g. LIQUID_RNYQUIST_RRC) */ \
-/* _k : samples per symbol */ \
-/* _m : filter delay (symbols) */ \
-/* _beta : filter excess bandwidth */ \
-/* _ms : modulation scheme (e.g. LIQUID_MODEM_QPSK) */ \
+/* _k : samples per symbol, _k >= 2 */ \
+/* _m : filter delay (symbols), _m > 0 */ \
+/* _beta : filter excess bandwidth, 0 < _beta <= 1 */ \
+/* _ms : modulation scheme, e.g. LIQUID_MODEM_QPSK */ \
SYMSTREAM() SYMSTREAM(_create_linear)(int _ftype, \
unsigned int _k, \
unsigned int _m, \
float _beta, \
int _ms); \
\
-/* destroy symstream object, freeing all internal memory */ \
+/* Destroy symstream object, freeing all internal memory */ \
void SYMSTREAM(_destroy)(SYMSTREAM() _q); \
\
-/* print symstream object's parameters */ \
+/* Print symstream object's parameters */ \
void SYMSTREAM(_print)(SYMSTREAM() _q); \
\
-/* reset symstream internal state */ \
+/* Reset symstream internal state */ \
void SYMSTREAM(_reset)(SYMSTREAM() _q); \
\
-/* write block of samples to output buffer */ \
+/* Write block of samples to output buffer */ \
/* _q : synchronizer object */ \
/* _buf : output buffer [size: _buf_len x 1] */ \
/* _buf_len: output buffer size */ \
