On Sat, Jul 02, 2011 at 14:50:44 (CEST), Diego Biurrun wrote:
> ---
> libavcodec/aacps.c | 2 +-
> libavcodec/lpc.c | 2 +-
> libavcodec/vp8.c | 2 +-
> libavfilter/graphparser.c | 2 +-
> libavformat/wtv.c | 2 +-
> libavutil/imgutils.h | 4 ++--
> 6 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/libavcodec/aacps.c b/libavcodec/aacps.c
> index 724c132..d818790 100644
> --- a/libavcodec/aacps.c
> +++ b/libavcodec/aacps.c
> @@ -77,7 +77,7 @@ static VLC vlc_ps[10];
> * @param avctx contains the current codec context
> * @param gb pointer to the input bitstream
> * @param ps pointer to the Parametric Stereo context
> - * @param par pointer to the parameter to be read
> + * @param PAR pointer to the parameter to be read
> * @param e envelope to decode
> * @param dt 1: time delta-coded, 0: frequency delta-coded
> */
ok
> diff --git a/libavcodec/lpc.c b/libavcodec/lpc.c
> index ed985d3..31fa324 100644
> --- a/libavcodec/lpc.c
> +++ b/libavcodec/lpc.c
> @@ -149,7 +149,7 @@ static int estimate_best_order(double *ref, int
> min_order, int max_order)
> /**
> * Calculate LPC coefficients for multiple orders
> *
> - * @param use_lpc LPC method for determining coefficients
> + * @param lpc_type LPC method for determining coefficients
> * 0 = LPC with fixed pre-defined coeffs
> * 1 = LPC with coeffs determined by Levinson-Durbin recursion
> * 2+ = LPC with coeffs determined by Cholesky factorization using
> (use_lpc-1) passes.
Not completely wrong, but probably this should rather refer to the
documentation of FFLPCType, which documents the enum much better.
TBH, I'd rather remove the line, as the enum is already properly
linkified at least in the html output.
> diff --git a/libavcodec/vp8.c b/libavcodec/vp8.c
> index a3d01eb..47bec5e 100644
> --- a/libavcodec/vp8.c
> +++ b/libavcodec/vp8.c
> @@ -1036,7 +1036,7 @@ static const uint8_t subpel_idx[3][8] = {
> *
> * @param s VP8 decoding context
> * @param dst target buffer for block data at block position
> - * @param src reference picture buffer at origin (0, 0)
> + * @param ref reference picture buffer at origin (0, 0)
> * @param mv motion vector (relative to block position) to get pixel data
> from
> * @param x_off horizontal position of block from origin (0, 0)
> * @param y_off vertical position of block from origin (0, 0)
okay, but as indicated in the comment before, AFAIUI this doxy block
should be duplicated to vp8_mc_chroma as well.
> diff --git a/libavfilter/graphparser.c b/libavfilter/graphparser.c
> index 00fb57a..c1624d8 100644
> --- a/libavfilter/graphparser.c
> +++ b/libavfilter/graphparser.c
> @@ -83,8 +83,8 @@ static char *parse_link_name(const char **buf, AVClass
> *log_ctx)
> * Create an instance of a filter, initialize and insert it in the
> * filtergraph in *ctx.
> *
> + * @param filt_ctx put here a filter context in case of successful creation
> and configuration, NULL otherwise.
> * @param ctx the filtergraph context
> - * @param put here a filter context in case of successful creation and
> configuration, NULL otherwise.
> * @param index an index which is supposed to be unique for each filter
> instance added to the filtergraph
> * @param filt_name the name of the filter to create
> * @param args the arguments provided to the filter during its initialization
Err, uh? I had to read the documentation string several times and still
don't get it. Does a filt_ctx get created if NULL is passed? The
function looks like an constructor to me, so in what cases wouldn't the
user want to pass NULL here?
> diff --git a/libavformat/wtv.c b/libavformat/wtv.c
> index 0f9fdef..cc6fc8b 100644
> --- a/libavformat/wtv.c
> +++ b/libavformat/wtv.c
> @@ -766,7 +766,7 @@ enum {
> * Parse WTV chunks
> * @param mode SEEK_TO_DATA or SEEK_TO_PTS
> * @param seekts timestamp
> - * @param[out] len Length of data chunk
> + * @param[out] len_ptr Length of data chunk
> * @return stream index of data chunk, or <0 on error
> */
OK
> static int parse_chunks(AVFormatContext *s, int mode, int64_t seekts, int
> *len_ptr)
> diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h
> index b569eb1..0666a28 100644
> --- a/libavutil/imgutils.h
> +++ b/libavutil/imgutils.h
> @@ -106,8 +106,8 @@ void av_image_copy_plane(uint8_t *dst, int
> dst_linesize,
> /**
> * Copy image in src_data to dst_data.
> *
> - * @param dst_linesize linesizes for the image in dst_data
> - * @param src_linesize linesizes for the image in src_data
> + * @param dst_linesizes linesizes for the image in dst_data
> + * @param src_linesizes linesizes for the image in src_data
> */
> void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
> const uint8_t *src_data[4], const int src_linesizes[4],
Doxy seems pretty obvious to me, but OK.
--
Gruesse/greetings,
Reinhard Tartler, KeyID 945348A4
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
