diff options
| author | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-12-15 13:36:34 +0000 |
|---|---|---|
| committer | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-12-15 13:36:34 +0000 |
| commit | 3a4ba3f4b600b131295c37e0c0ad3f68e98671c2 (patch) | |
| tree | 6aa323ef0b0f08973c3cdbfdcf445b6a5d2adcec /include/asterisk/tdd.h | |
| parent | cb3a26307c65e477f5d2b3047d22c4ecc7d027c0 (diff) | |
Doxygen changes
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@48491 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/tdd.h')
| -rw-r--r-- | include/asterisk/tdd.h | 18 |
1 files changed, 6 insertions, 12 deletions
diff --git a/include/asterisk/tdd.h b/include/asterisk/tdd.h index bdd02bb40..fae569702 100644 --- a/include/asterisk/tdd.h +++ b/include/asterisk/tdd.h @@ -29,14 +29,12 @@ struct tdd_state; typedef struct tdd_state TDDSTATE; -/*! CallerID Initialization */ -/*! +/*! CallerID Initialization * Initializes the TDD system. Mostly stuff for inverse FFT */ void tdd_init(void); -/*! Generates a CallerID FSK stream in ulaw format suitable for transmission. */ -/*! +/*! Generates a CallerID FSK stream in ulaw format suitable for transmission. * \param tdd tdd structure * \param buf Buffer to use. This needs to be large enough to accomodate all the generated samples. * \param string This is the string to send. @@ -45,15 +43,13 @@ void tdd_init(void); */ int tdd_generate(struct tdd_state *tdd, unsigned char *buf, const char *string); -/*! Create a TDD state machine */ -/*! +/*! Create a TDD state machine * This function returns a malloc'd instance of the tdd_state data structure. * Returns a pointer to a malloc'd tdd_state structure, or NULL on error. */ struct tdd_state *tdd_new(void); -/*! Read samples into the state machine, and return character (if any). */ -/*! +/*! Read samples into the state machine, and return character (if any). * \param tdd Which state machine to act upon * \param ubuf containing your samples * \param samples number of samples contained within the buffer. @@ -64,15 +60,13 @@ struct tdd_state *tdd_new(void); */ int tdd_feed(struct tdd_state *tdd, unsigned char *ubuf, int samples); -/*! Free a TDD state machine */ -/*! +/*! Free a TDD state machine * \param tdd This is the tdd_state state machine to free * This function frees tdd_state tdd. */ void tdd_free(struct tdd_state *tdd); -/*! Generate Echo Canceller diable tone (2100HZ) */ -/*! +/*! Generate Echo Canceller disable tone (2100HZ) * \param outbuf This is the buffer to receive the tone data * \param len This is the length (in samples) of the tone data to generate * Returns 0 if no error, and -1 if error. |