eirikn at kerneled.com
Sun Oct 19 02:28:33 PDT 2003
On Sun, Oct 19, 2003 at 09:47:48AM +0100, Hiten Pandya wrote:
> David Cuthbert wrote:
> >Matthew Dillon wrote:
> >> I don't think we want to integrate document generation into the
> >> code. The problem is that you can't get too wordy without making the
> >> source unreadable, and the result are usually definitions so
> >>sparse as
> >> to be useless for understanding any serious API.
> >Yeah, Doxygen (and JavaDoc) both result in code that's more sparse than
> >I care for, making it more difficult for maintainers. For users of the
> >code, though, the indices and cross-reference tables that result are
> >quite valuable.
> I would rather prefer documenting the necessary/important
> functions by hand in a DragonFly Kernel Handbook, which keeps
> things clean, and also allows detailed explanations.
I agree with Hiten. It would be better to document the necessary functions
by hand in a some kind of a handbook and perhaps use it together with a
source code tag system. http://www.gnu.org/software/global/global.html is
nice, it can also make web pages for you so you can like to it from the
eirikn at xxxxxxxxxxxx
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 187 bytes
Desc: "Description: PGP signature"
More information about the Kernel