[FFmpeg-devel] [PATCH] doc/muxers: add flv muxer document into doc/muxers

[Lou Logan]

On Thu, 15 Sep 2016 12:02:15 +0800, Steven Liu wrote:

> From 0a62f9cb55df317c7c3df47d31e345cb9ad593d0 Mon Sep 17 00:00:00 2001
> From: Steven Liu <lingjiujianke at gmail.com>
> Date: Thu, 15 Sep 2016 11:59:35 +0800
> Subject: [PATCH] doc/muxers: add flv muxer document into doc/muxers
> 
> add flvflags aac_seq_header_detect and flvflags no_sequence_end document
> into doc/muxers
> 
> Signed-off-by: Steven Liu <lingjiujianke at gmail.com>
> ---
>  doc/muxers.texi | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index ccf8ea1..8d94136 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -1047,6 +1047,24 @@ ffmpeg -i file.mpg -c copy \
>       -y out.ts
>  @end example
>  
> + at section flv

Your documentation is in the wrong location: it should be in
alphabetical order, so place it between the crc and framecrc sections.

> +Adobe Flash Video Format muxer.
> +This muxer accepts the following options:

Please add a blank line between the two sentences above.

> + at table @option
> + at item flvflags @var{flags}
> +This flag currently supports the following flags:

I prefer:
"Possible values:"

Optionally, you can add a short description of flvflags if it makes
sense to do so. See the other flag type options for examples.

> + at table @samp
> + at item aac_seq_header_detect
> +If this flag is set, the muxer will put AAC sequence header based on audio stream data.

Can be shortened to:
"Place AAC sequence header based on audio stream data."

> + at item no_sequence_end
> +If this flag is set, the muxer will have no sequence end tag at the end of flv.

Can be shortened to:
"Disable sequence end tag."