[FFmpeg-devel] [PATCH 2/2] doc/filters: reformat and rework gradfun.

[Stefano Sabatini]

On date Tuesday 2012-12-18 22:24:07 +0100, Clément Bœsch encoded:
> Note that examples are changed.
> ---
>  doc/filters.texi | 34 +++++++++++++++++++++++++---------
>  1 file changed, 25 insertions(+), 9 deletions(-)
> 
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 6e9ebc7..e7d23b4 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -2668,27 +2668,43 @@ bring back the bands.
>  The filter accepts a list of options in the form of @var{key}=@var{value} pairs
>  separated by ":". A description of the accepted options follows.
>  
> - at var{strength} is the maximum amount by which the filter will change
> + at table @option
> +
> + at item strength
> +The maximum amount by which the filter will change
>  any one pixel. Also the threshold for detecting nearly flat
> -regions. Acceptable values range from .51 to 64, default value is
> -1.2.
> +regions. Acceptable values range from @code{0.51} to @code{64}, default value
> +is @code{1.2}.
>  
> - at var{radius} is the neighborhood to fit the gradient to. A larger
> + at item radius
> +The neighborhood to fit the gradient to. A larger
>  radius makes for smoother gradients, but also prevents the filter from
>  modifying the pixels near detailed regions. Acceptable values are
> -8-32, default value is 16.
> + at code{8-32}, default value is @code{16}.
> +
> + at end table
>  
>  Alternatively, the options can be specified as a flat string:
>  @var{strength}[:@var{radius}]
>  
> + at subsection Examples
> +
> + at itemize
> + at item

> +Gradfun with a @code{3.5} strength and radius of @code{8}:

Nit:
Apply the filter with ...

>  @example
> -# default parameters
> -gradfun=1.2:16
> +gradfun=3.5:8
> + at end example
>  
> -# omitting radius
> -gradfun=1.2
> + at item
> +Specify radius, omitting the strength (which will fall-back to the default
> +value):
> + at example
> +gradfun=radius=8
>  @end example
>  
> + at end itemize
> +
>  @section hflip

LGTM, thanks.
-- 
FFmpeg = Fast and Formidable Meaningful Patchable Explosive Gadget