[Ffmpeg-devel] [RFC][PATCH]Doxygenize libavutil/fifo.h

[Dujardin Bernard]

Michael Niedermayer a ?crit :
> Hi
>
> On Mon, Feb 26, 2007 at 12:48:58PM +0100, Dujardin Bernard wrote:
>   
>>>> #ifndef FIFO_H
>>>> #define FIFO_H
>>>>
>>>> +/**
>>>> + * Circular fifo buffer.
>>>> + */
>>>> typedef struct AVFifoBuffer {
>>>> -    uint8_t *buffer;
>>>> -    uint8_t *rptr, *wptr, *end;
>>>> +    uint8_t *buffer;    ///< Begin pointer.
>>>> +    uint8_t *rptr;      ///< Read pointer.
>>>> +    uint8_t *wptr;      ///< Write pointer.
>>>> +    uint8_t *end;       ///< End pointer.
>>>>    
>>>>         
>>> these comments are completely redundant they provide no new
>>> information to the reader, for external API i dont mind some extra
>>> redundant comments which have the advantage of being nicely shown with
>>> doxygen but for internal structs which the user has no business with
>>> its not
>>>
>>>  
>>>       
>> Lets the Circular fifo buffer comment ?
>>     
>
> comments about the implementation should be avoided in public header files
> to prevent users from writing code which depends on the implementation details
> such code breaks if the implementation changes
> actually AVFifoBuffer should be moved away from fifo.h
>   
I've removed all structure's comments and made others corrections.

Regards
Bernard

-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: fifo_h.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070226/7e09d41a/attachment.asc>
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: fifo_c.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070226/7e09d41a/attachment.txt>