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

[Michael Niedermayer]

On Sat, Nov 02, 2013 at 12:54:31PM -0700, Timothy Gu wrote:
> On Nov 2, 2013 12:31 PM, "Michael Niedermayer" <michaelni at gmx.at> wrote:
> >
> > 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
> 
> If so, then
> 
> 1. The 2 types of Doxygen should be clearly documented on
> website/documentation and also how to generate them.

yes


> 
> 2a. The Doxygen on the website should be generated by `make apidoc`, not
> the current form (with the other patch in the patch set which fixes style
> of course).
> 2b. An alternative solution to 2a is to change the section name on the
> website from "API doc" to "Doxygen doc for FFmpeg developers", but this
> method should not be used as not many FFmpeg devs use Doxygen AFAIK.

2c. build both variants on the server (though i dont volunteer
setting that up)


> 
> 3. Optionally add another build rule in Makefile.

this could make sense, anyone else has oppinons about that or what
exact command the 2nd rule should have ?


[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Good people do not need laws to tell them to act responsibly, while bad
people will find a way around the laws. -- Plato
-------------- 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/66267a0c/attachment.asc>