APIDOX Changes

Adriaan de Groot groot at kde.org
Tue Jul 5 22:28:05 BST 2005

As some of you may have noticed, the APIDOX for KDE SVN trunk have undergone 
considerable revision. Allen Winter and myself have been putting a lot of 
effort into cleaning them up, styling them nicely, and making them all-round 
more accessible. We have done this for the modules we could find that have 
API dox -- that is kdelibs, kdebase, kdepim and koffice [*].

An index to the resulting collections of API dox can be found at 
http://developer.kde.org/documentation/library/cvs-api/ . From there you can 
reach the dox for the four modules. One of the cool features (I think) is 
that the dox are cross-referenced where possible, so that KDE PIM dox can 
lead you astray into kdelibs as needed.

NOTE that some URLs you may have bookmarked may have changed. It used to be 
the case that http://developer.kde.org/documentation/library/cvs-api/<foo> 
would give you relevant kdelibs dox -- for instance, for <foo> equal to 
"dcop/" you would get the DCOP dox. One additional layer has been introduced, 
leading to 
instead. This might also be important to external references to the SVN dox.

Another possibly useful feature is the class lister, which gives you a quick 
overview of the classes defined in a module. It's at 
http://developer.kde.org/documentation/library/cvs-api/classmapper.php -- 
pick a module, perhaps enter a string to match, hit submit. Useful if you 
want dox on klineedit but don't know where it lives (well, you still need to 
guess to look in kdelibs).

Should you notice dox weirdness -- missing bits, broken links, whatever -- 
please let me know. I'm sure there's still bugs in the dox themselves and the 
generation code.


[*] KDevelop also has API dox, but generates them in a completely different 
manner from other modules, so we haven't touched it.

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

More information about the kde-core-devel mailing list