[FFmpeg-devel] [RFC] Better modularization and extension of docs - 2

[Clément Bœsch]

On Thu, Nov 22, 2012 at 12:57:18PM +0100, Stefano Sabatini wrote:
> On date Tuesday 2012-11-20 22:55:46 +0100, Clément Bœsch encoded:
> > On Sat, Nov 17, 2012 at 01:52:48PM +0100, Stefano Sabatini wrote:
> [...]
> > > My planned solution at this point would be:
> > > 
> > > - ff* tools manual pages
> > > 
> > > - components manual pages: codecs, formats, devices, protocols,
> > >   filters, bitstream filters, syntax, eval (or syntax containing eval)
> > > 
> > > - lib*.texi pages with a short library description and link/mention to
> > >   doxygen documentation, converted relevant doxygen in the best case,
> > >   but this could be technically difficult to achieve
> > > 
> > 
> > Sounds pretty sane overall, except for the syntax dedicated manpage for
> > which I'm a bit uncomfortable.
> > 
> > > I'm not sure how to deal with libswrescale and libswresample. Having a
> > > separated ffmpeg-scaler and libswscale, and ffmpeg-resampler and
> > > libswresample pages may be a bit overkill.
> > > 
> > 
> > For users, these libraries are only accessible through the filters. Usage
> > will be documented there.
> 
> I dislike the idea of documenting scaler and resampler options in
> filter documentation.

That's not what I meant sorry: I was just saying that for non-API user,
the scaler and resampler are only accessible through filters, so you
shouldn't need to add an extra documentation with all the available
options; these options will be documented in libswresample.texi and
libswscale.texi since they should only be accessible through the API.

[...]

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121124/92373324/attachment.asc>