[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    Re: doxygen docs on developer.kde.org
From:       Scott Wheeler <wheeler () kde ! org>
Date:       2003-04-09 1:43:48
[Download RAW message or body]

On Wednesday 09 April 2003 3:34, Neil Stevens wrote:
> On Tuesday April 08, 2003 01:15, Scott Wheeler wrote:
> > Is there any reason to not switch our default doc format over to
> > Doxygen?
> 
> Does/can Doxygen make docs for classes and methods without comments yet?

It can (and always has been able to), but it doesn't seem to with KDE 
doxyfile.  This can of course be changed.

> Can it make globals browsable yet?  Those are the only two issues I've had
> with the Doxygen docs.

Hmm, don't know on this one, but I'll see what I can figure out.  I presume 
that it is possible.  In the event that it's not, I'm sure we can talk to the 
Doxygen guy about getting support in.  As I recall he's quite fond of KDE/Qt 
(Doxygen uses Qt) and I'm sure would be willing to work with us.
 
> It's really annoying to read docs for a class but have to also go read the
> source to see methods that are missing.  It's also unfortunate to have
> classes missing in the class lists becuase nobody added docs to them yet.
> 
> Also, docs for common functions like i18n, locate, and the Icon loader are
> pretty important.  With the kdoc output, there's a nice Globals link to
> get access to all of them.

Yes, I agree.  One thing I hoped was that doing a switch would be a motivation 
to work out the remaining issues.  On the whole the doxygen docs have more 
information, are prettier (not by virtue of Doxygen itself, but they're nice 
in KDE usage) and much better cross referenced, so it'd be nice to get the 
last issues cleared away.  Oh, and I have a nifty klib:<class name> shortcut 
that works for Doxygen output that I should commit at some point (in kdesdk).  
:-)

Cheers,

-Scott

-- 
There are 10 types of people in the world: Those who understand binary, and 
those who don't.

[prev in list] [next in list] [prev in thread] [next in thread]