[FFmpeg-cvslog] doxygen: Drop array size declarations from Doxygen parameter names.

Reinhard Tartler git at videolan.org
Tue Jul 26 00:53:20 CEST 2011


ffmpeg | branch: release/0.8 | Reinhard Tartler <siretart at tauware.de> | Sun Jul  3 19:00:59 2011 +0200| [f95e5225fe1b94c5c2ee683fa75aafed22c5b3e1] | committer: Reinhard Tartler

doxygen: Drop array size declarations from Doxygen parameter names.

Adding [] to a Doxygen parameter name clashes with Doxygen syntax.
(cherry picked from commit ff993cd7fcdfeffcac10337c0c6b69c599060c2b)

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=f95e5225fe1b94c5c2ee683fa75aafed22c5b3e1
---

 libavcodec/cook.c                |    2 +-
 libavcodec/motion_est_template.c |    4 ++--
 libavutil/imgutils.h             |    2 +-
 libavutil/lfg.h                  |    2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/libavcodec/cook.c b/libavcodec/cook.c
index 84211a6..05d8d7a 100644
--- a/libavcodec/cook.c
+++ b/libavcodec/cook.c
@@ -335,7 +335,7 @@ static av_cold int cook_decode_close(AVCodecContext *avctx)
  * Fill the gain array for the timedomain quantization.
  *
  * @param gb          pointer to the GetBitContext
- * @param gaininfo[9] array of gain indexes
+ * @param gaininfo    array[9] of gain indexes
  */
 
 static void decode_gain_info(GetBitContext *gb, int *gaininfo)
diff --git a/libavcodec/motion_est_template.c b/libavcodec/motion_est_template.c
index 6b807dc..d65edd9 100644
--- a/libavcodec/motion_est_template.c
+++ b/libavcodec/motion_est_template.c
@@ -990,8 +990,8 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm
         return   var_diamond_search(s, best, dmin, src_index, ref_index, penalty_factor, size, h, flags);
 }
 
-/*!
-   \param P[10][2] a list of candidate mvs to check before starting the
+/**
+   @param P a list of candidate mvs to check before starting the
    iterative search. If one of the candidates is close to the optimal mv, then
    it takes fewer iterations. And it increases the chance that we find the
    optimal mv.
diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h
index b569eb1..fad4435 100644
--- a/libavutil/imgutils.h
+++ b/libavutil/imgutils.h
@@ -69,7 +69,7 @@ int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int widt
  *
  * @param data pointers array to be filled with the pointer for each image plane
  * @param ptr the pointer to a buffer which will contain the image
- * @param linesizes[4] the array containing the linesize for each
+ * @param linesizes the array containing the linesize for each
  * plane, should be filled by av_image_fill_linesizes()
  * @return the size in bytes required for the image buffer, a negative
  * error code in case of failure
diff --git a/libavutil/lfg.h b/libavutil/lfg.h
index 89a635a..904d00a 100644
--- a/libavutil/lfg.h
+++ b/libavutil/lfg.h
@@ -55,7 +55,7 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
  * Get the next two numbers generated by a Box-Muller Gaussian
  * generator using the random numbers issued by lfg.
  *
- * @param out[2] array where the two generated numbers are placed
+ * @param out array where the two generated numbers are placed
  */
 void av_bmg_get(AVLFG *lfg, double out[2]);
 



More information about the ffmpeg-cvslog mailing list