diff options
| author | Russell Bryant <russell@russellbryant.com> | 2005-10-24 20:12:06 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2005-10-24 20:12:06 +0000 |
| commit | 3453e3efa54bd013beb4c5bfcaf05df1f10d6798 (patch) | |
| tree | b3ba750361c8145e6c629b37179fb9f1750094b4 /include/asterisk/fskmodem.h | |
| parent | c3226a226a57e71f608b1990bff4ee48c836bde0 (diff) | |
Doxygen documentation update from oej (issue #5505)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6847 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/fskmodem.h')
| -rwxr-xr-x | include/asterisk/fskmodem.h | 9 |
1 files changed, 5 insertions, 4 deletions
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: |