Date: Tue, 17 Apr 2001 13:11:53 -0500 From: "Daryl Chance" <dchance@midsouth.rr.com> To: <doc@freebsd.org> Subject: Programmers Documentation Project Message-ID: <001901c0c769$e2282870$0200000a@satan>
next in thread | raw e-mail | index | archive | help
Hi, I was looking through the list of projects to see if one existed for documenting the FBSD code. The closest I came to it was this: http://home.wxs.nl/~asmodai/pdp.html Does anyone know if there has been any recent work done on this? the top of this page: http://home.wxs.nl/~asmodai/source-overview.txt Has a date of 1999/04/01, a little over 2 years. I say this is the closest, because I was looking for something else, something a little more "thourough", like (I realize this would be a HUGE undertaking) commenting all the functions in the FBSD source and running something like ScanDoc against it or some other auto- matic code documentation programs. Anyone have any suggestions? Offer any help? I thought about this which watching the recent discussion on "VM Balance" on -stable. This would be a great project to start so that someone interested in browsing the FBSD source can see more then just the code, they can see the functions, structs, etc etc and read the comments against those. It may help the people doing work on FBSD to learn more about the source. Thoughts? I'd be willing to help out, or even lead this project. I do think this would take a lot of patience from the -stable people answering our questions about things that they would consider trivial :). I'm only on a Cable connection w/ a K6 333 as my most powerful server, but I can offer up this to see this project get off the ground and to show that theres some interest. I'd also have to learn scandoc or whatever documentation tool we plan on using if theres any interest. Thanks, Daryl Chance To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?001901c0c769$e2282870$0200000a>