[FFmpeg-devel] [PATCH] Doxygenate libavutil/mem.h

[Diego Biurrun]

On Thu, Sep 20, 2007 at 08:53:44PM +0200, Stefano Sabatini wrote:
> 
> this patch documents the interface of the functions in
> libavutil/mem.h.
> 
> Suggested log: $subject
> 
> --- libavutil/mem.h	(revision 10534)
> +++ libavutil/mem.h	(working copy)
> @@ -33,26 +33,46 @@
>  
> + * @return Pointer to the allocated block, NULL if it can't allocate
> + * it.

if it cannot be allocated

> + * Allocates or reallocates a block of memory.
> + * Same semantics as glibc realloc: if \p ptr is NULL and \p size > 0,
> + * identical to malloc(size). If \p size is zero, it is identical to
>   * free(ptr) and NULL is returned.

What is supposed to be "identical to malloc(size)"?

> + * @param ptr Pointer to an already allocated memory block or NULL.
> + * @return Pointer to a newly reallocated block or NULL if it can't
> + * reallocate or the function is used to free the memory block.

if it cannot be allocated

> +/**
> + * Allocates a block of \p size bytes with alignment suitable for all
> + * memory accesses (including vectors if available on the CPU) and
> + * sets to zero all the bytes of the block. av_mallocz(0) must return

zeroes all the bytes of the block

> + * a non NULL pointer.

non-NULL

> + * @return Pointer to the allocated block, NULL if it can't allocate
> + * it.

see above

Please avoid short forms.

Diego