[FFmpeg-devel] [PATCH 3/4] doc/muxers: add "Options", "Examples", "Syntax", etc. subsections

[Stefano Sabatini]

On date Saturday 2014-01-04 19:24:31 -0800, Timothy Gu encoded:
> More consistent with codec docs.
> 
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
>  doc/muxers.texi | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 59 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index 8a2bed0..e795e91 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -23,6 +23,8 @@ A description of some of the currently available muxers follows.
>  
>  Audio Interchange File Format muxer.
>  
> + at subsection Options
> +
>  It accepts the following options:
>  
>  @table @option
> @@ -45,10 +47,14 @@ and video frames. By default audio frames are converted to signed
>  16-bit raw audio and video frames to raw video before computing the
>  CRC.
>  

> + at subsection Output Syntax

I'm against some of these subsections, as they look overkill and
highly fragmented documentation for a few paragraph is annoying.

Same for examples, it makes sense to have a separated section only if
there are many examples, for one or two examples it is probably
overkill.
-- 
FFmpeg = Freak and Fascinating Meaningless Problematic Explosive Goblin