From owner-freebsd-current@FreeBSD.ORG Tue Mar 29 14:12:03 2005 Return-Path: Delivered-To: freebsd-current@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 18BDA16A4CE; Tue, 29 Mar 2005 14:12:03 +0000 (GMT) Received: from mailout11.sul.t-online.com (mailout11.sul.t-online.com [194.25.134.85]) by mx1.FreeBSD.org (Postfix) with ESMTP id E2E3643D5A; Tue, 29 Mar 2005 14:12:01 +0000 (GMT) (envelope-from Alexander@Leidinger.net) Received: from fwd28.aul.t-online.de by mailout11.sul.t-online.com with smtp id 1DGHRo-0008Ap-07; Tue, 29 Mar 2005 16:12:00 +0200 Received: from Andro-Beta.Leidinger.net (Z2qN+6ZC8ekmC4sRVLDzvuCbCEff6XaAeewVtW91KgJMFcgdkvtPsw@[217.229.214.41]) by fwd28.sul.t-online.de with esmtp id 1DGHRe-24mO4e0; Tue, 29 Mar 2005 16:11:50 +0200 Received: from localhost (localhost [127.0.0.1])j2TEAPB2063421; Tue, 29 Mar 2005 16:10:25 +0200 (CEST) (envelope-from Alexander@Leidinger.net) Received: from 141.113.101.32 ([141.113.101.32]) by netchild.homeip.net (Horde) with HTTP for ; Tue, 29 Mar 2005 16:10:25 +0200 Message-ID: <20050329161025.qkdv3dy63owkskco@netchild.homeip.net> X-Priority: 3 (Normal) Date: Tue, 29 Mar 2005 16:10:25 +0200 From: Alexander Leidinger To: Doug Rabson References: <20050327151754.2ee82124@Magellan.Leidinger.net> <200503290952.38133.dfr@nlsystems.com> <20050329153602.mh5n2wmhw4kws0ko@netchild.homeip.net> <8417928e592ac60198a5be991950db40@nlsystems.com> In-Reply-To: <8417928e592ac60198a5be991950db40@nlsystems.com> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-15; format="flowed" Content-Disposition: inline Content-Transfer-Encoding: 7bit User-Agent: Internet Messaging Program (IMP) H3 (4.0.2) / FreeBSD-4.11 X-ID: Z2qN+6ZC8ekmC4sRVLDzvuCbCEff6XaAeewVtW91KgJMFcgdkvtPsw@t-dialin.net X-TOI-MSGID: 3b02f6b4-de14-415c-a4ae-e0a4549abb3b cc: freebsd-current@freebsd.org cc: doc@freebsd.org Subject: Re: Doxygen docu for parts of the FreeBSD kernel X-BeenThere: freebsd-current@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Discussions about the use of FreeBSD-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 29 Mar 2005 14:12:03 -0000 Doug Rabson wrote: On 29 Mar 2005, at 14:36, Alexander Leidinger wrote: > > Doug Rabson wrote: > > > >> You could also take a look at /usr/src/sys/doc/{Makefile,Doxyfile} > >> which already generates docs for the kernel... > > > > I didn't knowed about it. What about > > - "doxygen -u"? > > That would end up modifying Doxyfile every time you ran it? I would > prefer that the thing worked with a read-only source tree (possibly > with an option for upgrading when you really intend it). Sorry, my intention was to suggest an update of the Doxyfile by hand, since doxygen has some new features, e.g. generating multiple output files in one dot(1) run (for recent versions of dot). I prefer that it works with a read-only source tree to. > > - making the doxygen documentation available on our web pages? > > I don't know any of the people responsible for the FreeBSD web site. > It would be nice to include an 'annotated kernel' on the website [doc@ CCed] Is there anyone out there who is able to integrate the output of "cd /usr/src/sys/doc; make all" (or similar for http://www.leidinger.net/FreeBSD/FreeBSD-Dox.tar.bz2) into our website? > > - defining __FreeBSD__ to 6? > > This should change. I did the thing last year while current was still > 5-current. ATM it isn't defined at all... except I've overloked it. > > It's nice if you want the complete picture, but if you're only > > interested in > > a part of the kernel it needs a lot of time to generate the docs > > (compared > > to my modular aproach). > > I haven't had a chance to look at your version yet. At work we use > doxygen on a large modular project and the tag-file feature works > really well for binding the various module's documentation together. That's the way I did it. I've broken up the kernel into different parts (sound, usb, i4b, ...) which reference other parts with the tag-file feature. I may not have all dependencies correct, and I haven't all parts of the kernel added to the set, but I think it's already usable if you're interested in just a part of the kernel. Bye, Alexander. -- http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID = B0063FE7 http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID = 72077137 No matter what happens, there is always someone who knew it would.