aboutsummaryrefslogtreecommitdiffstats
path: root/include/asterisk/alaw.h
diff options
context:
space:
mode:
authoroej <oej@f38db490-d61c-443f-a65b-d21fe96a405b>2007-12-11 14:17:29 +0000
committeroej <oej@f38db490-d61c-443f-a65b-d21fe96a405b>2007-12-11 14:17:29 +0000
commit2020d2079737c991a378ee3e486099fee5363337 (patch)
tree6cca3e832b35c1035169d9fea07aa663936c3839 /include/asterisk/alaw.h
parent19b0b540555a50cab713bd16c46a1936c43e9718 (diff)
A lot of doxygen updates
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@92285 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/alaw.h')
-rw-r--r--include/asterisk/alaw.h9
1 files changed, 3 insertions, 6 deletions
diff --git a/include/asterisk/alaw.h b/include/asterisk/alaw.h
index 34968969d..0ef42becc 100644
--- a/include/asterisk/alaw.h
+++ b/include/asterisk/alaw.h
@@ -24,8 +24,7 @@
#define _ASTERISK_ALAW_H
-/*! Init the ulaw conversion stuff */
-/*!
+/*! \brief
* To init the alaw to slinear conversion stuff, this needs to be run.
*/
void ast_alaw_init(void);
@@ -37,9 +36,7 @@ void ast_alaw_init(void);
#define AST_ALAW_AMI_MASK 0x55
-/*! converts signed linear to alaw */
-/*!
- */
+/*! \brief converts signed linear to alaw */
#ifndef G711_NEW_ALGORITHM
extern unsigned char __ast_lin2a[8192];
#else
@@ -55,7 +52,7 @@ extern short __ast_alaw[256];
#define AST_LIN2A_LOOKUP(mag) \
__ast_lin2a[(mag) >> AST_ALAW_BIT_LOSS]
-/*! convert signed linear sample to sign-magnitude pair for a-Law */
+/*! \brief Convert signed linear sample to sign-magnitude pair for a-Law */
static inline void ast_alaw_get_sign_mag(short sample, unsigned *sign, unsigned *mag)
{
/* It may look illogical to retrive the sign this way in both cases,