DragonFly kernel List (threaded) for 2009-09
DragonFly BSD
DragonFly kernel List (threaded) for 2009-09
[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]

Re: DoxyGen Style Kernel API reference.


From: "Simon 'corecode' Schubert" <corecode@xxxxxxxxxxxx>
Date: Sat, 05 Sep 2009 12:46:11 +0200

Sascha Wildner wrote:
Brian Gianforcaro schrieb:
Depending on how nice you want the documentation to be, and how good
the existing documentation is.

I'd be more than willing to put all my effort into modifying the
existing comments to be doxygen compliant, if this what is finally
decided.
Maintaining man9 and doxygen in parallel? I think there is even less chance that developers will care about both man9 & doxygen than taking care of man9 alone.

I actually don't think so. Docs can be copied from the doxygen to the man page format.


I worked on the linux source in the last days, and I have to say that proper doxygen comments are *really* helpful for navigating in unknown code.

I strongly support Brian's enthusiasm and suggest just going forward and doing it. Let's see how it is working out. The more documentation the better. I don't think we should turn this into a lengthy discussion.

cheers
  simon



[Date Prev][Date Next]  [Thread Prev][Thread Next]  [Date Index][Thread Index]