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

[Diego Biurrun]

On Thu, Mar 01, 2007 at 11:34:30AM +0100, Panagiotis Issaris wrote:
> 
> Diego Biurrun schreef:
> > 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
> >> - * 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.
> Yep, works fine (with Doxygen 1.5.1). If anyone has problems with it, I
> can of course reformat it.

I'd slightly prefer it on the same line for readability, but this is a
very minor issue.

Diego