kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen changes

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48491 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Olle Johansson
2006-12-15 13:36:34 +00:00
parent 168deb2366
commit 0722c9ae77
2 changed files with 8 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/asterisk/tdd.h
View File

@@ -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.