[FFmpeg-devel] [PATCH] documentation: add sections linking components and libraries documentation

[Stefano Sabatini]

On date Tuesday 2012-12-18 13:10:02 +0100, Stefano Sabatini encoded:
> On date Tuesday 2012-12-18 02:37:40 +0100, Clément Bœsch encoded:
> > On Tue, Dec 18, 2012 at 01:58:29AM +0100, Stefano Sabatini wrote:
> > > NOTE: pages should be present and updated on the server
> > 
> > They aren't at the moment.
> > 
> > > ---
> > >  src/documentation |   25 ++++++++++++++++++++++++-
> > >  1 file changed, 24 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/src/documentation b/src/documentation
> > > index 68b25c4..61bbf13 100644
> > > --- a/src/documentation
> > > +++ b/src/documentation
> > > @@ -7,7 +7,7 @@ developers will be able to better diagnose the problem if you follow
> > >  <a href="bugreports.html">these bug reporting guidelines</a>.
> > >  </p>
> > >  
> > > -<h2>Command Line Interface (CLI) and Related Usage Documentation</h2>
> > > +<h2>Command Line Tools Related Usage Documentation</h2>
> > 
> 
> > I wonder if "Command Line Interface" wouldn't be enough.
> 
> I prefer "Tools" since it is more explicit (Command Line Interface is
> a bit generic).
> 
> > >  <ul>
> > >  <li><a href="ffmpeg.html">ffmpeg</a></li>
> > >  <li><a href="ffplay.html">ffplay</a></li>
> > > @@ -15,6 +15,29 @@ developers will be able to better diagnose the problem if you follow
> > >  <li><a href="ffserver.html">ffserver</a> and a <a href="sample.html">sample ffserver configuration file</a></li>
> > >  </ul>
> > >  
> > > +<h2>Components Documentations</h2>
> > > +<ul>
> > > +<li><a href="ffmpeg-utils.html">FFmpeg utilities</a></li>
> > > +<li><a href="ffmpeg-scaler.html">FFmpeg video scaling and pixel format converter</a></li>
> > > +<li><a href="ffmpeg-resampler.html">FFmpeg resampler</a></li>
> > 
> > Just like the entry above, maybe "FFmpeg audio resampler" would be
> > welcome.
> > 
> > > +<li><a href="ffmpeg-codecs.html">FFmpeg codecs</a></li>
> > 
> > "FFmpeg encoders and decoders (codecs)"?
> > 
> > > +<li><a href="ffmpeg-bitstream-filters.html">FFmpeg bitstream filters</a></li>
> > > +<li><a href="ffmpeg-formats.html">FFmpeg formats (muxers and demuxers)</a></li>
> > 
> > "FFmpeg muxers and demuxers (formats)"?
> > 
> > > +<li><a href="ffmpeg-devices.html">FFmpeg input and output devices</a></li>
> > > +<li><a href="ffmpeg-filters.html">FFmpeg filters</a></li>
> > > +</ul>
> > > +
> > > +<h2>Library Documentation</h2>
> > > +<ul>
> > > +<li><a href="libavutil.html">libavutil</a>
> > > +<li><a href="libswscale.html">libswscale</a>
> > > +<li><a href="libswresample.html">libswresample</a>
> > > +<li><a href="libavcodec.html">libavcodec</a>
> > > +<li><a href="libavformat.html">libavformat</a>
> > > +<li><a href="libavdevice.html">libavdevice</a>
> > > +<li><a href="libavfilter.html">libavfilter</a>
> > > +</ul>
> > > +
> > 
> > Otherwise LGTM, when pages are generated on the server.
> > 
> > Anyway, good work, thanks, I'm looking forward this.
> 
> Updated, I'll push when I'm sure the files are properly uploaded on
> the server.

Pushed.
-- 
FFmpeg = Fanciful and Forgiving Marvellous Plastic Elaborated Ghost