On 21-08-2020 06:05 pm, Nicolas George wrote:
1. What would you think about putting the documentation for
libavfilter/vf_foobar.c into libavfilter/doc/vf_foobar.texi instead
of into huge doc/filters.texi (25k lines!)? And same for codecs,
formats, etc.
We can adopt this for new documentation and move progressively
existing components.
Sounds fine.
2. What would you think about switching from texinfo to a small basic
subset of HTML for new documentation?
I think most of us are much more familiar with HTML syntax than with
texinfo.
Markdown is preferred.
3. What would you think about using pandoc for processing the
documentation?
4. What would you think about including the documentation for components
into the libraries? It would allow GUI applications to present it in
dialog boxes, like spreadsheets do with their math functions.
(4 certainly depends on 2, because texinfo is nos suited for that use;
and probably in part on 1.)
Another aspect is to preserve version-specific documentation in addition
to the version-less (effectively git master) docs that we currently
have. It's too much effort to retroactively generate this for past
releases, but it can be can be done starting with 4.3 and current major
versions of the libs.
Gyan
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
