# HG changeset patch # User jbr # Date 1184810998 0 # Node ID 83682d6837e4aeb9bb13738ca1c526dd0acf932e # Parent 7659a1acfba4ce66de7ed4df9d262405471e676a revise comment for exponent decoding function diff -r 7659a1acfba4 -r 83682d6837e4 ac3dec.c --- a/ac3dec.c Thu Jul 19 02:04:05 2007 +0000 +++ b/ac3dec.c Thu Jul 19 02:09:58 2007 +0000 @@ -445,16 +445,16 @@ } } -/* 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)