From 3bb004fcda5e2dad6c308bce5b27ba1d0fbcf1a6 Mon Sep 17 00:00:00 2001
From: Justin Ruggles <justin.ruggles@gmail.com>
Date: Thu, 19 Jul 2007 02:09:58 +0000
Subject: [PATCH] revise comment for exponent decoding function
Originally committed as revision 9750 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
libavcodec/ac3dec.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/libavcodec/ac3dec.c b/libavcodec/ac3dec.c
index 21240691f78..a6df77c7277 100644
--- a/libavcodec/ac3dec.c
+++ b/libavcodec/ac3dec.c
@@ -445,16 +445,16 @@ static void ac3_parse_bsi(AC3DecodeContext *ctx)
}
}
-/* Decodes the grouped exponents.
+/**
+ * Decodes the grouped exponents.
* This function decodes the coded exponents according to exponent strategy
* and stores them in the decoded exponents buffer.
*
- * @param gb GetBitContext which points to start of coded exponents
- * @param expstr Exponent coding strategy
- * @param ngrps Number of grouped exponetns
- * @param absexp Absolute exponent
- * @param dexps Decoded exponents are stored in dexps
- * @return Returns 0 if exponents are decoded successfully, -1 if error occurs
+ * @param[in] gb GetBitContext which points to start of coded exponents
+ * @param[in] expstr Exponent coding strategy
+ * @param[in] ngrps Number of grouped exponents
+ * @param[in] absexp Absolute exponent or DC exponent
+ * @param[out] dexps Decoded exponents are stored in dexps
*/
static void decode_exponents(GetBitContext *gb, int expstr, int ngrps,
uint8_t absexp, uint8_t *dexps)
--
GitLab