[Ffmpeg-devel] [RFC][PATCH]Doxygenize libavutil/fifo.h
Dujardin Bernard
dujardin.iut
Tue Feb 27 17:12:16 CET 2007
Hi,
I submit ;-) attached patch which take account of your remarks.
Diego Biurrun a ?crit :
> On Mon, Feb 26, 2007 at 05:13:04PM +0100, Dujardin Bernard wrote:
>
>> + * @file fifo.h
>> + * A very simple circular buffer FIFO implementation.
>>
>> @@ -6,15 +12,74 @@
>>
>> +/**
>> + * Initializes a fifo *.
>>
>
> I suggest that you always uppercase FIFO.
>
I've applied this only on \brief comments
>> +/**
>> + * Reads the data from the fifo *.
>> + * @param *f fifo buffer.
>> + * @param *buf data destination.
>> + * @param size of data.
>>
>
> Shouldn't this be 'buf_size'?
>
Yes it is
> Also, I wouldn't add periods at the end of sentences without a verb.
>
Applied
>
>> + * @return -1 if not enough data.
>> + */
>> int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
>> +
>> +/**
>> + * Reads the data from the fifo *.
>> + * @param *f fifo buffer.
>> + * @param *buf_size data size.
>>
>
> Isn't buf_size an int and not a pointer?
>
yes it is
>
>> + * @param *func generic read function.
>> + * @param *dest data destination.
>> + * @return -1 if not enough data.
>> + */
>> int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest);
>> +
>> +/**
>> + * Resizes the fifo *.
>> + * @param *f fifo buffer.
>> + * @param new_size.
>>
>
> Why do you call it new_size?
>
I've worked on file.c and in this file argument's name is new_size.
I've replaced by size like in fifo.h.
> + */
> void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
> +
> +/**
> + * Discards the data from the fifo *
>
>
> I would add a period here ;)
>
>
I've added this forgotten period.
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: fifo_h.patch
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070227/76659348/attachment.txt>
More information about the ffmpeg-devel
mailing list