Quoting [EMAIL PROTECTED] (from Sun, 21 May 2006 14:48:37 -0700):
At Fri, 19 May 2006 14:31:16 +0200,
Alexander Leidinger wrote:
Quoting "George V. Neville-Neil" <[EMAIL PROTECTED]> (from Thu, 18
May 2006 10:14:26 -0700):
> I so hate to chime in on this thread, but I really think we need to
> start putting things into the code and using Doxygen, or a moral
> equivalent, to at least have a chance of keeping such things up to
> date. Someone a while back set up a proper Doxygen file for use with
> FreeBSD and we might simply pursue that tack.
http://www.leidinger.net/FreeBSD/src_docs/
http://www.leidinger.net/FreeBSD/FreeBSD-Dox.tar.bz2
Feel free to send/suggest further subsystems/improvements.
The one thing I'd like to suggest is that this be made part of the
tree with an optional make target. How should we go about doing that?
We already have a doxygen config file in the tree, it covers the
entire kernel. But I think my approach of generating docs for
subsystems instead of the entire kernel may be more easy to understand
for people which want to understand a part of the kernel.
Regarding the make target, do you think about "cd /usr/src; make
doxygen" or about "cd /usr/src/<mumble>; make doxygen"?
The targets in the .tar.bz2 generate a HTML version too. Currently the
HTML version is around 300 MB, and it only covers a small part of the
kernel. Shall the HTML version also be generated (not available
online)? What about the destination, where do you want the HTML
version and/or the PDF version (needs pdflatex as a build tool) to be
placed (I can't come up with a good destination)? The HTML version is
generated by doxygen directly, the PDF needs to be generated from the
latex version, so in case of the PDF version it would make sense to
have a "doxygen" and "doxygeninstall" target, but not for the HTML
version (except you want to generate everything in OBJDIR and then do
a copy to the destination).
Yes, I'm asking bikeshed questions... but only because I can't think
of a good answer myself ATM.
Bye,
Alexander.
--
Selling GoodYear Eagle F1 235/40ZR18, 2x 4mm + 2x 5mm, ~150 EUR
you have to pick it up between Germany/Saarland and Luxembourg/Capellen
http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID = B0063FE7
http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID = 72077137
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "[EMAIL PROTECTED]"
