[FFmpeg-devel] [PATCH] mem: Extend and edit Doxygen

[Michael Niedermayer]

On Tue, Aug 02, 2016 at 10:22:21AM -0700, Timothy Gu wrote:
> ---
> 
> A bit more editing...
> 
> ---
>  libavutil/mem.h | 588 +++++++++++++++++++++++++++++++++++++++++++-------------
>  1 file changed, 451 insertions(+), 137 deletions(-)
> 
> diff --git a/libavutil/mem.h b/libavutil/mem.h
> index 145ac91..4b99342 100644
> --- a/libavutil/mem.h
> +++ b/libavutil/mem.h
> @@ -20,7 +20,8 @@
>  
>  /**
>   * @file
> - * memory handling functions
> + * @ingroup lavu_mem
> + * Memory handling functions
>   */
>  
>  #ifndef AVUTIL_MEM_H
> @@ -35,9 +36,56 @@
>  
>  /**
>   * @addtogroup lavu_mem
> + * Utilities for manipulating memory.
> + *
> + * FFmpeg has several applications of memory that are not required of a typical
> + * program. For example, the computing-heavy components like video decoding and
> + * encoding can be sped up significantly through the use of aligned memory.
> + *
> + * However, for each of FFmpeg's applications of memory, there might not be a
> + * recognized or standardized API for that specific use. Memory alignment, for
> + * instance, varies wildly depending on operating systems, architectures, and
> + * compilers. Hence, this component of @ref libavutil is created to make
> + * dealing with memory consistently possible on all platforms.
> + *
> + * @{
> + *
> + * @defgroup lavu_mem_macros Alignment Macros
> + * Helper macros for declaring aligned variables.
>   * @{
>   */
>  
> +/**
> + * @def DECLARE_ALIGNED(n,t,v)
> + * Declare a variable that is aligned in the memory.

to me it sounds more natural without "the" but english aint my area

either way the patch overall looks nice (i didnt deeply review)
Acked-by: Michael

Thanks

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Complexity theory is the science of finding the exact solution to an
approximation. Benchmarking OTOH is finding an approximation of the exact
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20160805/96b335d2/attachment.sig>