[Ffmpeg-devel] Documentation for public use and internal use

Panagiotis Issaris takis.issaris
Fri Mar 2 14:47:36 CET 2007


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

I think it would be a good idea to have separate documentation for
public use, which would document the public API only for users of
libavcodec/libavformat/libavutil/libswscale. And separate documentation
for the FFmpeg developers which would be pretty much the same as the
current documentation. This should make it much easier to get started
and find documentation for users of the various FFmpeg libraries.

To illustrate this, I've put up a webpage doing this:
http://lumumba.uhasselt.be/~takis/ffmpeg/

The public API documentation is generated from a second Doxygen
configuration file which uses only the header files which would have
been installed. For this to work, all the Doxygen comments have to be
moved to the public header files. The patch I posted yesterday [1]
starts doing this for libavformat. I've just prepared more patches doing
the same for libavutil (which were already used to generate the
documentation at the previously listed URL).

Anyone agree that this would make the documentation _much_ clearer for
users of the various FFmpeg libs?

With friendly regards,
Takis

[1] http://article.gmane.org/gmane.comp.video.ffmpeg.devel/45501
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFF6Cr49kOxLuzz4CkRAiPUAJ4ois5N/jYxKNSIDMgaHylFgrQnqQCcC1EK
s10eWGqjxo660g/lY5QlKFI=
=h6kP
-----END PGP SIGNATURE-----




More information about the ffmpeg-devel mailing list