[Kde-games-devel] Using Doxygen for KShisen

[Parker Coates]

On Mon, Feb 2, 2009 at 14:05, Frederik Schwarzer wrote:
> 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.

That seems like a sane solution to me. You want to name the second one
"Doxyfile.includingPrivate" or something similarly verbose just to be
a bit clearer. My first thought on seeing Doxyfile.all would be that
the "all" was referring to all files, which would then cause me to
wonder what the regular Doxyfile was for.

Great to see all the work you've been doing lately, by the way.

Parker