[Kde-games-devel] Using Doxygen for KShisen

Frederik Schwarzer schwarzerf at gmail.com
Mon Feb 2 20:05:22 CET 2009


On Monday 02 February 2009 01:03:19 Mauricio Piacentini wrote:
> Frederik Schwarzer wrote:
> > Hi,
> > 
> > currently I am adding some doxygen documentation to the KShisen sources.
> > The goal is to have a description for every function about what it is for exactly
> > and why... in a browsable and printable form.
> > Is it ok to have an own Doxyfile that extracts private members as well and
> > maybe sometimes describes internal structures?
> > Or does that collide with the KDE doxygen creation?
> 
> I know next to nothing about this, but there is api.kde.org, and it 
> links to pages with information about the doxygen guidelines for the 
> project. Maybe it helps?

Yes, interesting read.
I will probably just go with two Doxyfile config files:
Doxyfile for KDE's infrastructure
Doxyfile.all for local usage if private members shall be extracted too.

Regards


More information about the kde-games-devel mailing list