[FFmpeg-devel] [PATCH 1/2] Prettify eval.h doxy.

[Michael Niedermayer]

On Tue, Jun 01, 2010 at 10:26:01AM +0200, Stefano Sabatini wrote:
> ---
>  libavcodec/eval.h |   73 ++++++++++++++++++++++++++++++++--------------------
>  1 files changed, 45 insertions(+), 28 deletions(-)
> 
> diff --git a/libavcodec/eval.h b/libavcodec/eval.h
> index e37b11a..1db2b0c 100644
> --- a/libavcodec/eval.h
> +++ b/libavcodec/eval.h
> @@ -33,18 +33,26 @@ typedef struct AVExpr AVExpr;
>   * Note, this is significantly slower than ff_eval_expr().
>   *
>   * @param res a pointer to a double where is put the result value of
> - * the expression, or NAN in case of error
> - * @param s expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)"
> - * @param const_names NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0}
> - * @param const_values a zero terminated array of values for the identifers from const_names
> - * @param func1_names NULL terminated array of zero terminated strings of funcs1 identifers
> - * @param funcs1 NULL terminated array of function pointers for functions which take 1 argument
> - * @param func2_names NULL terminated array of zero terminated strings of funcs2 identifers
> - * @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments
> - * @param opaque a pointer which will be passed to all functions from funcs1 and funcs2
> + *        the expression, or NAN in case of invalid expression
> + * @param s expression as a zero terminated string, for example
> + *        "1+2^3+5*5+sin(2/3)"
> + * @param const_names NULL terminated array of zero terminated strings
> + *        of constant identifers, for example {"PI", "E", 0}
> + * @param const_values a zero terminated array of values for the
> + *        identifers from const_names
> + * @param func1_names NULL terminated array of zero terminated strings
> + *        of funcs1 identifers
> + * @param funcs1 NULL terminated array of function pointers for
> + *        functions which take 1 argument
> + * @param func2_names NULL terminated array of zero terminated strings
> + *        of funcs2 identifers
> + * @param funcs2 NULL terminated array of function pointers for
> + *        functions which take 2 arguments
> + * @param opaque a pointer which will be passed to all functions from
> + *        funcs1 and funcs2

should be:

> - * @param s            expression as a zero terminated string for example "1+2^3+5*5+sin(2/3)"
> - * @param const_names  NULL terminated array of zero terminated strings of constant identifers for example {"PI", "E", 0}
> - * @param const_values a zero terminated array of values for the identifers from const_names
> - * @param func1_names  NULL terminated array of zero terminated strings of funcs1 identifers
> - * @param funcs1       NULL terminated array of function pointers for functions which take 1 argument
> - * @param func2_names  NULL terminated array of zero terminated strings of funcs2 identifers
> - * @param funcs2       NULL terminated array of function pointers for functions which take 2 arguments
> - * @param opaque       a pointer which will be passed to all functions from funcs1 and funcs2

anyway, all break at 80 column blindy changes are rejected

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Old school: Use the lowest level language in which you can solve the problem
            conveniently.
New school: Use the highest level language in which the latest supercomputer
            can solve the problem without the user falling asleep waiting.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20100601/01491337/attachment.pgp>