[Ffmpeg-devel] [PATCH] Add Doxygen documentation to avcodec.h pix_fmt related stuff

[Diego Biurrun]

On Wed, Feb 28, 2007 at 06:06:15PM +0100, Panagiotis Issaris wrote:
> 
> The attached patch tries to add documentation to some avcodec.h's
> pix_fmt related functions and defines.
> 
> --- a/libavcodec/avcodec.h
> +++ b/libavcodec/avcodec.h
> @@ -2489,21 +2489,56 @@ void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
> +#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. rgb to gray conversion) */

Nit: RGB

> - * find best pixel format to convert to. Return -1 if none found
> + * Finds the best pixel format to convert to given a certain source pixel
> + * format.  When converting from one pixel format to another, information loss
> + * may occur.  For example, when converting from RGB24 to GRAY, the color
> + * information will be lost. Similarly, other losses occur when converting from
> + * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
> + * the given pixel formats should be used to undergo the least amount of losses.
> + * The pixel formats from which it choses one, are determined by the \p
> + * pix_fmt_mask parameter.

Having a newline after \p works?  I'm asking out of curiosity.

> + * @param[in] has_alpha Whether the source pixel format alpha channel is being
> + * used.

IMO s/being//

Looks fine otherwise.

Diego