From: Olle Johansson <oej@edvina.net>
Date: Fri, 15 Dec 2006 13:36:34 +0000 (+0000)
Subject: Doxygen changes
X-Git-Tag: 1.6.0-beta1~3^2~3729
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0722c9ae7796538906fe3934d5428967c76723fa;p=thirdparty%2Fasterisk.git

Doxygen changes


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48491 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/include/asterisk/tdd.h b/include/asterisk/tdd.h
index bdd02bb401..fae5697026 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.
diff --git a/main/tdd.c b/main/tdd.c
index 7ac9153b3e..7189f490e6 100644
--- a/main/tdd.c
+++ b/main/tdd.c
@@ -262,7 +262,9 @@ int tdd_generate(struct tdd_state *tdd, unsigned char *buf, const char *str)
 	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;