Subject: Re: Doxygen generated documentation
To: None <email@example.com>
From: Rui Paulo <firstname.lastname@example.org>
Date: 05/21/2005 11:29:08
On 2005-05-21, Mark Kirby <email@example.com> wrote:
> On Saturday 21 May 2005 10:11, Rui Paulo wrote:
>> On 2005-05-21, Julio M. Merino Vidal <firstname.lastname@example.org> wrote:
>> > On Fri, 2005-05-20 at 23:49 -0400, Jan Schaumann wrote:
>> >> Rui Paulo <email@example.com> wrote:
>> >> > following Alexander Leidinger's work , I've generated Doxygen
>> >> > documentation of some NetBSD internal frameworks.
>> >> Hey, this is pretty cool! I don't know doxygen, but this looks like
>> >> something we may want to get onto our website, no?
>> > Yeah, I think so. I'm wondering... could this be extended to other
>> > subsystems? wscons comes to mind, for example.
>> Yes it can and it's pretty easy to do it. Anyway, doxygen is nice to find
>> duplicate header inclusion.
>> Take a look at this include dependency graph:
>> <sys/cdefs.h> is being included twice. I know we have #ifdef's so that they
>> don't mix, but removing this file from krpc_subr.c or nfs/krpc.h may speed
>> up compile time.
> Excellent idea Rui.
> Have you looked at the kde projects online api reference. This is doxygen done
> right http://developer.kde.org/documentation/library/cvs-api/ They even offer
> a down loadable version.
Yes, that's a very nice example of extending Doxygen. I think if we want to
integrate this kind of stuff in the NetBSD website, we must do something
similar so that it can cope with NetBSD.org look and feel. About the
downloadable version, Doxygen can do it by himself.
> I think they generate the doxygen pages every week or thereabouts
We could have the same timeline for NetBSD-current.
> Rui im more than happy to help you mark up code with doxygen comments
That's something that must be discussed, because not everyone may want to
add Doxygen comments to the source. Another ideia is to add some target
to build.sh/Makefile to generate Doxygen documentation.
Doxygen comments aren't very intrusive, though.
Rui Paulo <firstname.lastname@example.org>