[FFmpeg-cvslog] doc/filters: reformat and rework gradfun.

[Clément Bœsch]

ffmpeg | branch: master | Clément Bœsch <ubitux at gmail.com> | Tue Dec 18 22:19:34 2012 +0100| [fea6f5e14d1c625b45436126ab01d9862038417d] | committer: Clément Bœsch

doc/filters: reformat and rework gradfun.

Note that examples are changed.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=fea6f5e14d1c625b45436126ab01d9862038417d
---

 doc/filters.texi |   34 +++++++++++++++++++++++++---------
 1 file changed, 25 insertions(+), 9 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 6e9ebc7..611ddb6 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
+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
+ 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
 
 Flip the input video horizontally.