On Thu, Jan 02, 2014 at 09:41:15PM +0100, Maxim Polijakowski wrote:
> @subject.
> 
> This is an update fixing a critical bug...

Here is a Doxygen patch for you to squash into your tree and possibly
address the two remaining FIXMEs.

I cannot reproduce the artifacts I was hearing at some point anymore,
so this seems good to go.  Kostya?

Diego
>From 16d048bca0e454d019df6d494c7fcdfeae2ab66c Mon Sep 17 00:00:00 2001
From: Diego Biurrun <[email protected]>
Date: Fri, 3 Jan 2014 10:59:01 +0100
Subject: [PATCH] atrac3plus: Fix some doxygen documentation typos

Two parameters still need to be documented.
---
 libavcodec/atrac3plus.c    | 1 +
 libavcodec/atrac3plus.h    | 4 ++--
 libavcodec/atrac3plusdsp.c | 1 +
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/libavcodec/atrac3plus.c b/libavcodec/atrac3plus.c
index 3f992c1..7453b2c 100644
--- a/libavcodec/atrac3plus.c
+++ b/libavcodec/atrac3plus.c
@@ -247,6 +247,7 @@ static int num_coded_units(GetBitContext *gb, Atrac3pChanParams *chan,
  *
  * @param[in,out] ctx           ptr to the channel unit context
  * @param[in,out] chan          ptr to the channel parameters
+ * @param[in]     wtab_idx      FIXME: documentation
  * @param[in]     avctx         ptr to the AVCodecContext
  * @return result code: 0 = OK, otherwise - error code
  */
diff --git a/libavcodec/atrac3plus.h b/libavcodec/atrac3plus.h
index c93786f..e56c444 100644
--- a/libavcodec/atrac3plus.h
+++ b/libavcodec/atrac3plus.h
@@ -156,7 +156,7 @@ typedef struct Atrac3pChanUnitCtx {
 /**
  * Initialize VLC tables for bitstream parsing.
  *
- * @param[in]   ctx    ptr to the AVCodec
+ * @param[in]   codec    ptr to the AVCodec
  */
 void ff_atrac3p_init_vlcs(AVCodec *codec);
 
@@ -204,7 +204,7 @@ void ff_atrac3p_generate_tones(Atrac3pChanUnitCtx *ch_unit, AVFloatDSPContext *f
  * @param[in]      ch_index    which channel to process
  * @param[in,out]  sp          ptr to channel spectrum to process
  * @param[in]      rng_index   indicates which RNG table to use
- * @param[in]      sb          which subband to process
+ * @param[in]      sb_num      which subband to process
  */
 void ff_atrac3p_power_compensation(Atrac3pChanUnitCtx *ctx, int ch_index,
                                    float *sp, int rng_index, int sb_num);
diff --git a/libavcodec/atrac3plusdsp.c b/libavcodec/atrac3plusdsp.c
index d1f6463..50bcae4 100644
--- a/libavcodec/atrac3plusdsp.c
+++ b/libavcodec/atrac3plusdsp.c
@@ -116,6 +116,7 @@ av_cold void ff_atrac3p_init_wave_synth(void)
  *  @param[in]    synth_param   ptr to common synthesis parameters
  *  @param[in]    waves_info    parameters for each sine wave
  *  @param[in]    envelope      envelope data for all waves in a group
+ *  @param[in]    phase_shift   FIXME: documentation
  *  @param[in]    reg_offset    region offset for trimming envelope data
  *  @param[out]   out           receives sythesized data
  */
-- 
1.8.3.2

_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel

Reply via email to