[FFmpeg-devel] [PATCH 1/2] web/documentation: delete "libraies documentation" section

[Stefano Sabatini]

On date Saturday 2013-11-02 13:40:54 -0700, Timothy Gu encoded:
> The libraries documentation are documented in Doxygen.
> 
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
>  src/documentation | 11 -----------
>  1 file changed, 11 deletions(-)
> 
> diff --git a/src/documentation b/src/documentation
> index 9ac731c..fbb52fb 100644
> --- a/src/documentation
> +++ b/src/documentation
> @@ -30,17 +30,6 @@ Consult your locally installed documentation for older versions.
>  <li><a href="ffmpeg-filters.html">ffmpeg-filters</a>: FFmpeg filters</li>
>  </ul>
>  
> -<h2>Libraries Documentation</h2>
> -<ul>
> -<li><a href="libavutil.html">libavutil</a></li>
> -<li><a href="libswscale.html">libswscale</a></li>
> -<li><a href="libswresample.html">libswresample</a></li>
> -<li><a href="libavcodec.html">libavcodec</a></li>
> -<li><a href="libavformat.html">libavformat</a></li>
> -<li><a href="libavdevice.html">libavdevice</a></li>
> -<li><a href="libavfilter.html">libavfilter</a></li>
> -</ul>
> -

Just to make clear what's the intended usage of those files. Suppose
you have an external tool relying on libavX. Then you can reference it
in the manual by just saying "read libavX(3)" for more info about the
library. So while those file don't provide API information (which is
kept in doxygen/headers) they provide the external tool user some form
of reference documentation, and thus should be IMO retained.

What we could do is to reference the users to the API docs, which was
not done for technical reasons (integrate doxygen docs with texinfo).
-- 
FFmpeg = Faithless & Fanciful Muttering Prodigious Eager Guide