[svn-commits] oej: trunk r48491 - in /trunk: include/asterisk/tdd.h main/tdd.c

[svn-commits at lists.digium.com]

Author: oej
Date: Fri Dec 15 07:36:34 2006
New Revision: 48491

URL: http://svn.digium.com/view/asterisk?view=rev&rev=48491
Log:
Doxygen changes

Modified:
    trunk/include/asterisk/tdd.h
    trunk/main/tdd.c

Modified: trunk/include/asterisk/tdd.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/tdd.h?view=diff&rev=48491&r1=48490&r2=48491
==============================================================================
--- trunk/include/asterisk/tdd.h (original)
+++ trunk/include/asterisk/tdd.h Fri Dec 15 07:36:34 2006
@@ -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 @@
 */
 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 @@
  */
 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.

Modified: trunk/main/tdd.c
URL: http://svn.digium.com/view/asterisk/trunk/main/tdd.c?view=diff&rev=48491&r1=48490&r2=48491
==============================================================================
--- trunk/main/tdd.c (original)
+++ trunk/main/tdd.c Fri Dec 15 07:36:34 2006
@@ -262,7 +262,9 @@
 	int bytes=0;
 	int i,x;
 	char	c;
+	/*! Baudot letters */
 	static unsigned char lstr[31] = "\000E\nA SIU\rDRJNFCKTZLWHYPQOBG\000MXV";
+	/*! Baudot figures */
 	static unsigned char fstr[31] = "\0003\n- \00787\r$4',!:(5\")2\0006019?&\000./;";
 	/* Initial carriers (real/imaginary) */
 	float cr = 1.0;