From 2c3b3edc86c6999c3053c131972a3e29e7621bac Mon Sep 17 00:00:00 2001 From: russell Date: Mon, 24 Oct 2005 20:12:06 +0000 Subject: Doxygen documentation update from oej (issue #5505) git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6847 f38db490-d61c-443f-a65b-d21fe96a405b --- include/asterisk/fskmodem.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'include/asterisk/fskmodem.h') diff --git a/include/asterisk/fskmodem.h b/include/asterisk/fskmodem.h index 5f919c0f4..62b584ba4 100755 --- a/include/asterisk/fskmodem.h +++ b/include/asterisk/fskmodem.h @@ -16,9 +16,9 @@ * at the top of the source tree. */ -/* - * FSK Modem Support - * Includes code and algorithms from the Zapata library. +/*! \file + * \brief FSK Modem Support + * \note Includes code and algorithms from the Zapata library. */ #ifndef _ASTERISK_FSKMODEM_H @@ -57,7 +57,8 @@ typedef struct { float cola_demod[NCOLA]; /* Cola de muestras demoduladas */ } fsk_data; -/* Retrieve a serial byte into outbyte. Buffer is a pointer into a series of +/* \brief Retrieve a serial byte into outbyte. + Buffer is a pointer into a series of shorts and len records the number of bytes in the buffer. len will be overwritten with the number of bytes left that were not consumed, and the return value is as follows: -- cgit v1.2.3