Subject: Re: Doxygen generated documentation
To: Rui Paulo <rpaulo@netbsd-pt.org>
From: Mark Kirby <mark@coris.org.uk>
List: tech-kern
Date: 05/21/2005 11:49:19
On Saturday 21 May 2005 10:11, Rui Paulo wrote:
> On 2005-05-21, Julio M. Merino Vidal <jmmv84@gmail.com> wrote:
> > On Fri, 2005-05-20 at 23:49 -0400, Jan Schaumann wrote:
> >> Rui Paulo <rpaulo@netbsd-pt.org> wrote:
> >> > following Alexander Leidinger's work [1], 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:
> 	http://www.netbsd-pt.org/users/rpaulo/doxygen/nfs/krpc__subr_8c.html
> <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.

I think they generate the doxygen pages every week or thereabouts 
automatically.

Rui im more than happy to help you mark up code with doxygen comments

On another note any chance of a link to the CVS Digest on the netbsd page 
somewhere?

Cheers

Mark
-- 
http://digest.coris.org.uk The NetBSD CVS Digest