Subject: Re: Doxygen generated documentation
To: Rui Paulo <rpaulo@netbsd-pt.org>
From: Julio M. Merino Vidal <jmmv84@gmail.com>
List: tech-kern
Date: 05/21/2005 14:10:03
On Sat, 2005-05-21 at 11:29 +0000, Rui Paulo wrote:

> > 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.

The thing is that we already have documentation for frameworks,
functions and data structures in manual pages; duplicating it inside
source code is not a very good idea, as I see it.

FWIW, the existing manual pages are very good.  Check, for example,
spl(9), mbuf(9), wscons(9), etc.

Cheers,

-- 
Julio M. Merino Vidal <jmmv84@gmail.com>
http://www.livejournal.com/users/jmmv/
The NetBSD Project - http://www.NetBSD.org/