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

[Panagiotis Issaris]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

Panagiotis Issaris schreef:
> Hi Diego,
> 
> 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
>>> @@ -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
> Indeed. Fixed.
> 
>>> - * 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.
> 
>>> + * @param[in] has_alpha Whether the source pixel format alpha channel is being
>>> + * used.
>> IMO s/being//
> Fixed.
> 
>> Looks fine otherwise.
> Thanks!
> 
> 
> Thanks for reviewing!
> 
> I'll send the update patch after lunch.
Attached you'll find the updated patch.

 avcodec.h |   49 +++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 41 insertions(+), 8 deletions(-)

With friendly regards,
Takis
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFF5r029kOxLuzz4CkRAlWvAJ9L+L9gE1ICpJlJhMHIX2tlfRNV7ACffVq7
Qp72Y6n18Mj8TP18jQRxlCY=
=Ky24
-----END PGP SIGNATURE-----
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pi-20070301T124524-ffmpeg-pix_fmt_dox.diff
Type: text/x-patch
Size: 3797 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070301/420de330/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pi-20070301T124524-ffmpeg-pix_fmt_dox.diff.sig
Type: application/octet-stream
Size: 65 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070301/420de330/attachment.obj>