changeset 12056:25e9cb2b9477 libavcodec

Fix misspelled parameter names in Doxygen documentation. This fixes one Doxygen warning each.
author diego
date Fri, 02 Jul 2010 10:49:29 +0000
parents 34b9819efef5
children 560095a27bd0
files atrac3.c cook.c elbg.c lzw.c mpegvideo.c mpegvideo_common.h rl2.c rle.h
diffstat 8 files changed, 13 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/atrac3.c	Fri Jul 02 10:37:13 2010 +0000
+++ b/atrac3.c	Fri Jul 02 10:49:29 2010 +0000
@@ -166,9 +166,9 @@
 /**
  * Atrac 3 indata descrambling, only used for data coming from the rm container
  *
- * @param in        pointer to 8 bit array of indata
- * @param bits      amount of bits
+ * @param inbuffer  pointer to 8 bit array of indata
  * @param out       pointer to 8 bit array of outdata
+ * @param bytes     amount of bytes
  */
 
 static int decode_bytes(const uint8_t* inbuffer, uint8_t* out, int bytes){
--- a/cook.c	Fri Jul 02 10:37:13 2010 +0000
+++ b/cook.c	Fri Jul 02 10:49:29 2010 +0000
@@ -708,7 +708,7 @@
  * Apply transform window, overlap buffers.
  *
  * @param q                 pointer to the COOKContext
- * @param inbuffer          pointer to the mltcoefficients
+ * @param buffer1           pointer to the mltcoefficients
  * @param gains_ptr         current and previous gains
  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
  */
@@ -877,7 +877,7 @@
  *
  * @param q                 pointer to the COOKContext
  * @param inbuffer          pointer to raw stream data
- * @param gain_ptr          array of current/prev gain pointers
+ * @param gains_ptr         array of current/prev gain pointers
  */
 
 static inline void
@@ -923,7 +923,7 @@
  *
  * @param q                 pointer to the COOKContext
  * @param decode_buffer     pointer to the mlt coefficients
- * @param gain_ptr          array of current/prev gain pointers
+ * @param gains             array of current/prev gain pointers
  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
  * @param out               pointer to the output buffer
  * @param chan              0: left or single channel, 1: right channel
--- a/elbg.c	Fri Jul 02 10:37:13 2010 +0000
+++ b/elbg.c	Fri Jul 02 10:49:29 2010 +0000
@@ -249,7 +249,7 @@
  * and update elbg->error, elbg->utility and elbg->nearest_cb.
  *
  * @param elbg  Internal elbg data
- * @param indexes      {luc (low utility cell, huc (high utility cell), cluc (closest cell to low utility cell)}
+ * @param idx   {luc (low utility cell, huc (high utility cell), cluc (closest cell to low utility cell)}
  */
 static void try_shift_candidate(elbg_data *elbg, int idx[3])
 {
--- a/lzw.c	Fri Jul 02 10:37:13 2010 +0000
+++ b/lzw.c	Fri Jul 02 10:49:29 2010 +0000
@@ -121,7 +121,7 @@
 
 /**
  * Initialize LZW decoder
- * @param s LZW context
+ * @param p LZW context
  * @param csize initial code size in bits
  * @param buf input data
  * @param buf_size input data size
@@ -161,7 +161,7 @@
  * NOTE: the algorithm here is inspired from the LZW GIF decoder
  *  written by Steven A. Bennett in 1987.
  *
- * @param s LZW context
+ * @param p LZW context
  * @param buf output buffer
  * @param len number of bytes to decode
  * @return number of bytes decoded
--- a/mpegvideo.c	Fri Jul 02 10:37:13 2010 +0000
+++ b/mpegvideo.c	Fri Jul 02 10:49:29 2010 +0000
@@ -1650,7 +1650,7 @@
  * @param dest_cr chroma cr/v destination pointer
  * @param dir direction (0->forward, 1->backward)
  * @param ref_picture array[3] of pointers to the 3 planes of the reference picture
- * @param pic_op halfpel motion compensation function (average or put normally)
+ * @param pix_op halfpel motion compensation function (average or put normally)
  * the motion vectors are taken from s->mv and the MV type from s->mv_type
  */
 static inline void MPV_motion_lowres(MpegEncContext *s,
--- a/mpegvideo_common.h	Fri Jul 02 10:37:13 2010 +0000
+++ b/mpegvideo_common.h	Fri Jul 02 10:49:29 2010 +0000
@@ -631,8 +631,8 @@
  * @param dest_cr chroma cr/v destination pointer
  * @param dir direction (0->forward, 1->backward)
  * @param ref_picture array[3] of pointers to the 3 planes of the reference picture
- * @param pic_op halfpel motion compensation function (average or put normally)
- * @param pic_op qpel motion compensation function (average or put normally)
+ * @param pix_op halfpel motion compensation function (average or put normally)
+ * @param qpix_op qpel motion compensation function (average or put normally)
  * the motion vectors are taken from s->mv and the MV type from s->mv_type
  */
 static av_always_inline void MPV_motion_internal(MpegEncContext *s,
--- a/rl2.c	Fri Jul 02 10:37:13 2010 +0000
+++ b/rl2.c	Fri Jul 02 10:49:29 2010 +0000
@@ -50,7 +50,7 @@
 /**
  * Run Length Decode a single 320x200 frame
  * @param s rl2 context
- * @param buf input buffer
+ * @param in input buffer
  * @param size input buffer size
  * @param out ouput buffer
  * @param stride stride of the output buffer
--- a/rle.h	Fri Jul 02 10:37:13 2010 +0000
+++ b/rle.h	Fri Jul 02 10:49:29 2010 +0000
@@ -28,7 +28,7 @@
  *                                                      Value before raw bytes is      (count ^ xor_raw) + add_raw.
  * @param outbuf Output buffer
  * @param out_size Maximum output size
- * @param ptr Input buffer
+ * @param inbuf Input buffer
  * @param bpp Bytes per pixel
  * @param w Image width
  * @return Size of output in bytes, or -1 if larger than out_size