apidocs problem

Adriaan de Groot groot at kde.org
Wed Aug 17 21:12:15 BST 2005

On Wednesday 17 August 2005 20:15, Alexander Dymo wrote:
> On Friday 12 August 2005 00:16, Adriaan de Groot wrote:
> > tag files in the subdirectories. Now, if KDevelop assumes that tag files
> > can only be one deep (ie. in kio/ but not in kio/kio/) then the code has
> > bad assumptions, but isn't broken. Subtle.
> Hmm, right. Andras, you can take a look at
> kdevelop/parts/documentation/plugins/doxygen/docdoxygenplugin.cpp #250
> There you will see that the code looks only one level deep into
> subdirectories. It doesn't create index for nested subdirs with .tag files.

So, what to do? Conceivably, I could munge the tag files to contain the tags 
of their subdirectories, but I wouldn't like it since it would add a lot of 
XML processing to the dox generation process. Can we call this KDevelop's 
fault this time around and fix it there?

> Our dox generation stuff looks and works similar to kdelibs one
> (using Doxyfile.am) but with one improvement. It can generate docs
> for nested library directories into separate dox dirs. For example,
> in kdevelop/lib nothing is built because DOXYGEN_EMPTY=yes is set
> in Makefile.am but from kdevelop/lib/interfaces separate dox dir is
> generated with separate prefix with separate title. Same is done for
> ldevelop/lib/util.

Right, and because of that improvement I copied the feature into the main KDE 
dox generation tools, so DOXYGEN_EMPTY now works across the entire source 
tree. It's useful here and there.

I ought to go back and try to port the KDevelop dox to the main framework, but 
I don't want to step on toes (nor, indeed, do I have much time to try it).

These are your friends - Adem
    GPG: FEA2 A3FE Adriaan de Groot

More information about the kde-core-devel mailing list