[FFmpeg-devel] [PATCH 2/2] doc/encoders: add wavpackenc doc

[Stefano Sabatini]

On date Tuesday 2013-12-17 21:12:08 -0800, Timothy Gu encoded:
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
>  doc/encoders.texi | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 63 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index 1c288f3..bbf0ac7 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1144,6 +1144,7 @@ transient response is a higher bitrate.
>  
>  @end table
>  
> + at anchor{libwavpack}
>  @section libwavpack
>  
>  A wrapper providing WavPack encoding through libwavpack.
> @@ -1155,7 +1156,7 @@ configuration. You need to explicitly configure the build with
>  @code{--enable-libwavpack}.
>  
>  Note that a libavcodec-native encoder for the WavPack codec exists so users can
> -encode audios with this codec without using this encoder.
> +encode audios with this codec without using this encoder. See @ref{wavpackenc}.
>  
>  @subsection Options
>  
> @@ -1190,6 +1191,67 @@ Same as @samp{3}, but with extra processing enabled.
>  @end table
>  @end table
>  
> + at anchor{wavpackenc}
> + at section wavpack
> +
> +WavPack lossless audio encoder.
> +
> +This is a libavcodec-native WavPack encoder. There is also an encoder based on
> +libwavpack, but there is virtually no reason to use that encoder.
> +
> +See also @ref{libwavpack}.
> +
> + at subsection Options
> +
> +The equivalent options for @command{wavpack} command line utility are listed in
> +parentheses.
> +
> + at subsubsection Shared options
> +
> +The following shared options are effective for this encoder. Only special notes
> +about this particular encoder will be documented here. For the general meaning
> +of the options, see @ref{codec-options,,the Codec Options chapter}.
> +
> + at table @option
> + at item frame_size (@emph{--blocksize})
> +For this encoder, the range for this option is between 128 and 131072. Default
> +is automatically decided based on sample rate and number of channel.
> +

> +For the complete formula of calculating default, please see
> + at file{libavcodec/wavpackenc.c} for more details.

Changed to:

For the complete formula of calculating default, see
@file{libavcodec/wavpackenc.c}.

which is simpler/less redundant. Also IMO "please" should be avoided
in reference docs, since the user is not pleasing the documentation
whether she checks or not.

[...]

Will push it soon, with the other patches in the patchset, thanks.
-- 
FFmpeg = Faithful & Faithless Merciless Ponderous Embarassing Guide