[FFmpeg-devel] [PATCH 1/2] doc/Makefile: scan all files, including .c files, for Doxygen

Michael Niedermayer michaelni at gmx.at
Sat Nov 2 20:31:17 CET 2013

On Sat, Nov 02, 2013 at 11:54:16AM -0700, Timothy Gu wrote:
> On Nov 2, 2013 11:40 AM, "Michael Niedermayer" <michaelni at gmx.at> wrote:
> >
> > On Fri, Nov 01, 2013 at 08:19:03PM -0700, Timothy Gu wrote:
> > > Make `make apidoc` the same as `doxygen doc/Doxyfile` and the online
> doc.
> > >
> > > Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> >
> > AFAIK the idea of apidoc is to build doxy covering only the public
> > external API
> Then why does http://ffmpeg.org/doxygen/trunk/index.html show everything?
> If changing the online one to show only the external API is one of the
> TODO's, then fine patch dropped. But what about the Doxygen categories in
> the avcodec.h which are obvious designed to contain .c files? Are they
> supposed to be removed too?

i would say, there are 2 different forms of doxygen docs that can be
generated, one for all code and one for just the external API.
First if usefull to anyone who wants to work on ffmpeg second is
usefull to people who want to use the code from their applications

Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Into a blind darkness they enter who follow after the Ignorance,
they as if into a greater darkness enter who devote themselves
to the Knowledge alone. -- Isha Upanishad
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20131102/4bc8ba6b/attachment.asc>

More information about the ffmpeg-devel mailing list