[FFmpeg-devel] [PATCH] doc/filters: extend syntax description for transpose, and add examples

[Clément Bœsch]

On Wed, Dec 12, 2012 at 12:37:07PM +0100, Stefano Sabatini wrote:
> ---
>  doc/filters.texi |   18 +++++++++++++++++-
>  1 file changed, 17 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/filters.texi b/doc/filters.texi
> index b9b0ded..e4c16b6 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -3886,7 +3886,12 @@ Default mode is @code{merge}.
>  
>  Transpose rows with columns in the input video and optionally flip it.
>  
> -This filter accepts the following named parameters:
> +The filter accepts parameters as a list of @var{key}=@var{value}
> +pairs, separated by ":". If the key of the first options is omitted,
> +the arguments are interpreted according to the following syntax:
> + at example
> +transpose=@var{dir}:@var{passthrough}
> + at end example
>  

example?

Note: we should document the shorthand syntaxes in a consistent way in
filters doc. Like making a section about shorthand, and referencing it
with something like:

  This filter also supports the @ref{shorthand} syntax:
  "@var{dir}:@var{passthrough}".

The shorthand section would give example with long, short, and mixed
syntaxes.

>  @table @option
>  @item dir
> @@ -3945,6 +3950,17 @@ Preserve landscape geometry (when @var{width} >= @var{height}).
>  Default value is @code{none}.
>  @end table
>  
> +For example to rotate by 90 degrees clockwise and preserve portrait
> +layout:
> + at example
> +transpose=dir=1:passthrough=portrait
> + at end example
> +
> +The command above can also be specified as:
> + at example
> +transpose=1:portrait
> + at end example
> +
>  @section unsharp
>  
>  Sharpen or blur the input video.

LGTM assuming you fixed my top first comment.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121212/7901b146/attachment.asc>