From owner-freebsd-current@FreeBSD.ORG Tue Mar 29 13:49:44 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 3AD7516A4CE for ; Tue, 29 Mar 2005 13:49:44 +0000 (GMT) Received: from mail.qubesoft.com (gate.qubesoft.com [217.169.36.34]) by mx1.FreeBSD.org (Postfix) with ESMTP id 632F043D41 for ; Tue, 29 Mar 2005 13:49:43 +0000 (GMT) (envelope-from dfr@nlsystems.com) Received: from [192.168.1.254] (dhcp254.qubesoft.com [192.168.1.254]) by mail.qubesoft.com (8.13.3/8.13.3) with ESMTP id j2TDngbh026737; Tue, 29 Mar 2005 14:49:42 +0100 (BST) (envelope-from dfr@nlsystems.com) In-Reply-To: <20050329153602.mh5n2wmhw4kws0ko@netchild.homeip.net> References: <20050327151754.2ee82124@Magellan.Leidinger.net> <200503290952.38133.dfr@nlsystems.com> <20050329153602.mh5n2wmhw4kws0ko@netchild.homeip.net> Mime-Version: 1.0 (Apple Message framework v619.2) Content-Type: text/plain; charset=US-ASCII; format=flowed Message-Id: <8417928e592ac60198a5be991950db40@nlsystems.com> Content-Transfer-Encoding: 7bit From: Doug Rabson Date: Tue, 29 Mar 2005 14:49:41 +0100 To: Alexander Leidinger X-Mailer: Apple Mail (2.619.2) X-Spam-Status: No, score=-2.8 required=5.0 tests=ALL_TRUSTED autolearn=failed version=3.0.1 X-Spam-Checker-Version: SpamAssassin 3.0.1 (2004-10-22) on mail.qubesoft.com cc: freebsd-current@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 13:49:44 -0000 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). > - 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 > - defining __FreeBSD__ to 6? This should change. I did the thing last year while current was still 5-current. > > 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. > > I've incorporated your *_if.m part (with some modifications), I will > make it > available from my website at the weekend when I'm back home (or per > mail on > request). You are welcome!