[FFmpeg-devel] [PATCH] Document opt.h:av_set_string functions

[Diego Biurrun]

On Fri, Jul 18, 2008 at 12:43:04AM +0200, Stefano Sabatini wrote:
> 
> --- libavcodec/opt.h	(revision 14259)
> +++ libavcodec/opt.h	(working copy)
> @@ -99,10 +99,30 @@
>  
>  /**
>   * Sets the field of obj with the given name to value.
> + *
> + * @param[in] obj a struct whose first element is a pointer to an
> + * AVClass

<complaint type="default" />

> + * @param[in] name the name of the field to set

<complaint type="default" />

> + * @param[in] val The value to set. If the field is not of a string
> + * type, then the given string is parsed.
> + * SI postfixes and some named scalars are supported.
> + * If the field is of a numeric type, it has to be a numeric or named
> + * scalar, behavior with more than one scalar and +- infix operators
> + * is undefined.

If in doubt, use a period instead of a comma.

> + * If the field is of a flags type, it has to be a sequence of numeric
> + * scalars or named flags separated by '+' or '-'. Prefixing a flag
> + * with '+' causes it to be set without affecting the other flags,
> + * similarly '-' unsets a flag.

Similarly?

> + * @return a pointer to the AVOption corresponding to the field set or
> + * NULL if no matching AVOption exists \e or the value \p val is not
> + * valid

<complaint type="default" />

Diego