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

[Diego Biurrun]

On Mon, Feb 26, 2007 at 05:13:04PM +0100, Dujardin Bernard wrote:
> I've removed all structure's comments and made others corrections.
> 
> --- fifo.h	(revision 8132)
> +++ fifo.h	(working copy)
> @@ -1,3 +1,9 @@
> +
> +/**
> + * @file fifo.h
> + * A very simple circular buffer FIFO implementation.
>  
> @@ -6,15 +12,74 @@
>  
> +/**
> + * Initializes a fifo *.

I suggest that you always uppercase FIFO.

> +/**
> + * Reads the data from the fifo *.
> + * @param *f fifo buffer.
> + * @param *buf data destination.
> + * @param size of data.

Shouldn't this be 'buf_size'?

Also, I wouldn't add periods at the end of sentences without a verb.

> + * @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?

> + * @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?

> + */
>  void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
> +
> +/**
> + * Discards the data from the fifo *

I would add a period here ;)

Diego