Generally, this diff was very hard to review. Perhaps some additional
lines of context would have helped.
On Sat, Jul 02, 2011 at 14:50:43 (CEST), Diego Biurrun wrote:
> ---
> libavcodec/ansi.c | 1 -
> libavcodec/h264idct_template.c | 1 -
> libavcodec/vp8.c | 3 ---
> libavformat/url.h | 4 ----
> libswscale/swscale.h | 1 -
> 5 files changed, 0 insertions(+), 10 deletions(-)
>
> diff --git a/libavcodec/ansi.c b/libavcodec/ansi.c
> index e46879d..376f7eb 100644
> --- a/libavcodec/ansi.c
> +++ b/libavcodec/ansi.c
> @@ -153,7 +153,6 @@ static void draw_char(AVCodecContext *avctx, int c)
>
> /**
> * Execute ANSI escape code
> - * @param <0 error
> */
> static int execute_code(AVCodecContext * avctx, int c)
> {
Err, what did the comment want to say? Maybe this should be
reformualated as @info or @warning.
> diff --git a/libavcodec/h264idct_template.c b/libavcodec/h264idct_template.c
> index e7f9af7..e288f9b 100644
> --- a/libavcodec/h264idct_template.c
> +++ b/libavcodec/h264idct_template.c
> @@ -237,7 +237,6 @@ void FUNCC(ff_h264_idct_add8)(uint8_t **dest, const int
> *block_offset, DCTELEM *
> }
> /**
> * IDCT transforms the 16 dc values and dequantizes them.
> - * @param qp quantization parameter
> */
> void FUNCC(ff_h264_luma_dc_dequant_idct)(DCTELEM *_output, DCTELEM *_input,
> int qmul){
> #define stride 16
seems okay, but I'm not sure whom this 'documentation' is supposed to help.
> diff --git a/libavcodec/vp8.c b/libavcodec/vp8.c
> index 282d2fd..a3d01eb 100644
> --- a/libavcodec/vp8.c
> +++ b/libavcodec/vp8.c
> @@ -641,8 +641,6 @@ void decode_mb_mode(VP8Context *s, VP8Macroblock *mb, int
> mb_x, int mb_y, uint8_
> * @param block destination for block coefficients
> * @param probs probabilities to use when reading trees from the bitstream
> * @param i initial coeff index, 0 unless a separate DC block is coded
> - * @param zero_nhood the initial prediction context for number of surrounding
> - * all-zero blocks (only left/top, so 0-2)
> * @param qmul array holding the dc/ac dequant factor at position 0/1
> * @return 0 if no coeffs were decoded
> * otherwise, the index of the last coeff decoded plus one
No, look at 1e7396795028af9eda3d69ada1402d6ef8996964, the doxygen
comment should have been moved as well.
> @@ -1037,7 +1035,6 @@ static const uint8_t subpel_idx[3][8] = {
> * Generic MC function.
> *
> * @param s VP8 decoding context
> - * @param luma 1 for luma (Y) planes, 0 for chroma (Cb/Cr) planes
> * @param dst target buffer for block data at block position
> * @param src reference picture buffer at origin (0, 0)
> * @param mv motion vector (relative to block position) to get pixel
> data from
Since 64233e702a95df9167e3362e58aae4e82ce2ddf8, it is likely no longer a
'generic' mc function. I guess this doxy comment should be copied (and
adapted) for vp8_mc_chroma as well.
> diff --git a/libavformat/url.h b/libavformat/url.h
> index caafe07..2d970a0 100644
> --- a/libavformat/url.h
> +++ b/libavformat/url.h
> @@ -67,8 +67,6 @@ typedef struct URLProtocol {
> * Create a URLContext for accessing to the resource indicated by
> * url, but do not initiate the connection yet.
> *
> - * @param puc pointer to the location where, in case of success, the
> - * function puts the pointer to the created URLContext
> * @param flags flags which control how the resource indicated by url
> * is to be opened
> * @return 0 in case of success, a negative value corresponding to an
wrong. the parameter is named 'url' instead of 'poc', but the
documentation itself doesn't need to be removed.
> @@ -85,8 +83,6 @@ int ffurl_connect(URLContext *h);
> * Create an URLContext for accessing to the resource indicated by
> * url, and open it.
> *
> - * @param puc pointer to the location where, in case of success, the
> - * function puts the pointer to the created URLContext
> * @param flags flags which control how the resource indicated by url
> * is to be opened
> * @return 0 in case of success, a negative value corresponding to an
same here.
> diff --git a/libswscale/swscale.h b/libswscale/swscale.h
> index 2aa5e50..3899596 100644
> --- a/libswscale/swscale.h
> +++ b/libswscale/swscale.h
> @@ -235,7 +235,6 @@ int sws_scale(struct SwsContext *context, const uint8_t*
> const srcSlice[], const
>
> /**
> * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
> - * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
> * @return -1 if not supported
> */
> int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
could be okay, as I don't see any reference to fullRange as well, but
that function should also be documented properly.
--
Gruesse/greetings,
Reinhard Tartler, KeyID 945348A4
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
