From owner-cvs-all@FreeBSD.ORG Sun May 28 19:16:27 2006 Return-Path: X-Original-To: cvs-all@FreeBSD.org Delivered-To: cvs-all@FreeBSD.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 78F3C16BBCD; Sun, 28 May 2006 19:16:27 +0000 (UTC) (envelope-from netchild@FreeBSD.org) Received: from www.ebusiness-leidinger.de (jojo.ms-net.de [84.16.236.246]) by mx1.FreeBSD.org (Postfix) with ESMTP id 72EA443D6D; Sun, 28 May 2006 19:16:20 +0000 (GMT) (envelope-from netchild@FreeBSD.org) Received: from Andro-Beta.Leidinger.net (p54A5F984.dip.t-dialin.net [84.165.249.132]) (authenticated bits=0) by www.ebusiness-leidinger.de (8.13.4/8.13.4) with ESMTP id k4SJFsui078414; Sun, 28 May 2006 21:15:55 +0200 (CEST) (envelope-from netchild@FreeBSD.org) Received: from Magellan.Leidinger.net (Magellan.Leidinger.net [192.168.1.1]) by Andro-Beta.Leidinger.net (8.13.4/8.13.3) with ESMTP id k4SJGG8b055421; Sun, 28 May 2006 21:16:17 +0200 (CEST) (envelope-from netchild@FreeBSD.org) Date: Sun, 28 May 2006 21:16:20 +0200 From: Alexander Leidinger To: John-Mark Gurney Message-ID: <20060528211620.766e0ed0@Magellan.Leidinger.net> In-Reply-To: <20060528184114.GR49081@funkthat.com> References: <200605261806.k4QI67D3007680@repoman.freebsd.org> <20060528184114.GR49081@funkthat.com> Organization: FreeBSD X-Mailer: Sylpheed-Claws 2.2.0 (GTK+ 2.8.17; i386-portbld-freebsd7.0) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Virus-Scanned: by amavisd-new Cc: cvs-src@FreeBSD.org, src-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto Doxyfile-dev_pci Doxyfile-dev_sound Doxyfile-dev_usb Doxyfile-geom Doxyfile-i4b Doxyfile-kern Doxyfile-libkern Doxyfile-linux Doxyfile-net80211 ... X-BeenThere: cvs-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: CVS commit messages for the entire tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 28 May 2006 19:16:37 -0000 Quoting John-Mark Gurney (Sun, 28 May 2006 11:41:15 -0700): > Alexander Leidinger wrote this message on Fri, May 26, 2006 at 18:06 +0000: > > This is the kernel subsystem API documentation generation framework. > > a) where is a guide for the proper bit for documenting, hopefully it's > simply adding a comment block in front of the function. > b) I really hope we don't start adding machine parsable tags, as > computers these days should be smart enough to parse data from human > parsable text. (i.e. ever look at reStructuredText?) It's not XML. The complete manual is at http://www.stack.nl/~dimitri/doxygen/manual.html How a comment in front of the function should look like is shown at http://www.stack.nl/~dimitri/doxygen/docblocks.html short: /** \brief Brief description. * Brief description continued. * * Detailed description starts here. */ A list of commands (like the \brief above) is at http://www.stack.nl/~dimitri/doxygen/commands.html 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