doc/filters: reformat and rework gradfun.
authorClément Bœsch <ubitux@gmail.com>
Tue, 18 Dec 2012 21:19:34 +0000 (22:19 +0100)
committerClément Bœsch <ubitux@gmail.com>
Wed, 19 Dec 2012 02:16:43 +0000 (03:16 +0100)
Note that examples are changed.

doc/filters.texi

index 6e9ebc7..611ddb6 100644 (file)
@@ -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.
 
-@var{strength} is the maximum amount by which the filter will change
+@table @option
+
+@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}.
 
-@var{radius} is the neighborhood to fit the gradient to. A larger
+@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.
+@code{8-32}, default value is @code{16}.
+
+@end table
 
 Alternatively, the options can be specified as a flat string:
 @var{strength}[:@var{radius}]
 
+@subsection Examples
+
+@itemize
+@item
+Apply the filter with a @code{3.5} strength and radius of @code{8}:
 @example
-# default parameters
-gradfun=1.2:16
+gradfun=3.5:8
+@end example
 
-# omitting radius
-gradfun=1.2
+@item
+Specify radius, omitting the strength (which will fall-back to the default
+value):
+@example
+gradfun=radius=8
 @end example
 
+@end itemize
+
 @section hflip
 
 Flip the input video horizontally.