[FFmpeg-devel] Documentation: proposed changes in the structure

Clément Bœsch u at pkh.me
Sat Aug 22 02:18:45 EEST 2020


On Sat, Aug 22, 2020 at 01:15:14AM +0200, Clément Bœsch wrote:
[...]
> But I think we have it wrong with the documentation approach. What is
> currently described within the code corresponds to the "technical
> documentation". While all the extra information on the filters may enter
> within the "explanation" and "tutorial" realm. This means that we could
> have a filter documentation that starts with the technical documentation
> (generated from the code) followed by all the "extra" detailed info on the
> filter themselves.

To clarify just a little here: the non technical documentation would be
written manually outside of the code, just like currently (except we would
strip out all the redundant info with the tech doc).

-- 
Clément B.


More information about the ffmpeg-devel mailing list