doc/filters: apply various rendering changes to the showspectrum docs
authorStefano Sabatini <stefasab@gmail.com>
Mon, 4 Feb 2013 23:10:31 +0000 (00:10 +0100)
committerStefano Sabatini <stefasab@gmail.com>
Mon, 4 Feb 2013 23:12:55 +0000 (00:12 +0100)
In particular: always use @table @samp for showing constant tables, add a
few empty lines for improving readability, and specify default value when
missing.

doc/filters.texi

index c04930f..76a73e6 100644 (file)
@@ -6052,22 +6052,42 @@ The filter accepts the following named parameters:
 @table @option
 @item size, s
 Specify the video size for the output. Default value is @code{640x512}.
+
 @item slide
 Specify if the spectrum should slide along the window. Default value is
 @code{0}.
+
 @item mode
-Specify display mode. Can be either @code{combined}: all channels are
-displayed in the same row, or @code{separate}: all channels are displayed
-in separate rows. Default value is @code{combined}.
+Specify display mode.
+
+It accepts the following values:
+@table @samp
+@item combined
+all channels are displayed in the same row
+@item separate
+all channels are displayed in separate rows
+@end table
+
+Default value is @samp{combined}.
+
 @item color
-Specify display color mode. Can be either @code{channel}: each channel
-is displayed in a separate color, or @code{intensity}: each channel is
-displayed using the same color scheme. Default value is @code{channel}.
+Specify display color mode.
+
+It accepts the following values:
+@table @samp
+@item channel
+each channel is displayed in a separate color
+@item intensity
+each channel is is displayed using the same color scheme
+@end table
+
+Default value is @samp{channel}.
+
 @item scale
 Specify scale used for calculating intensity color values.
 
 It accepts the following values:
-@table @option
+@table @samp
 @item lin
 linear
 @item sqrt
@@ -6078,6 +6098,8 @@ cubic root
 logarithmic
 @end table
 
+Default value is @samp{sqrt}.
+
 @item saturation
 Set saturation modifier for displayed colors. Negative values provide
 alternative color scheme. @code{0} is no saturation at all.