From owner-p4-projects@FreeBSD.ORG Tue May 22 08:18:51 2007 Return-Path: X-Original-To: p4-projects@freebsd.org Delivered-To: p4-projects@freebsd.org Received: by hub.freebsd.org (Postfix, from userid 32767) id A850F16A484; Tue, 22 May 2007 08:18:51 +0000 (UTC) X-Original-To: perforce@freebsd.org Delivered-To: perforce@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 546E316A480 for ; Tue, 22 May 2007 08:18:51 +0000 (UTC) (envelope-from alexander@leidinger.net) Received: from redbull.bpaserver.net (redbullneu.bpaserver.net [213.198.78.217]) by mx1.freebsd.org (Postfix) with ESMTP id 0AB2013C45A for ; Tue, 22 May 2007 08:18:50 +0000 (UTC) (envelope-from alexander@leidinger.net) Received: from outgoing.leidinger.net (p54a5f7b9.dip.t-dialin.net [84.165.247.185]) by redbull.bpaserver.net (Postfix) with ESMTP id 6442B2E137; Tue, 22 May 2007 10:18:47 +0200 (CEST) Received: from webmail.leidinger.net (webmail.Leidinger.net [192.168.1.102]) by outgoing.leidinger.net (Postfix) with ESMTP id F37D45B545F; Tue, 22 May 2007 10:18:30 +0200 (CEST) Received: (from www@localhost) by webmail.leidinger.net (8.13.8/8.13.8/Submit) id l4M8IUEH077033; Tue, 22 May 2007 10:18:30 +0200 (CEST) (envelope-from Alexander@Leidinger.net) Received: from pslux.cec.eu.int (pslux.cec.eu.int [158.169.9.14]) by webmail.leidinger.net (Horde MIME library) with HTTP; Tue, 22 May 2007 10:18:30 +0200 Message-ID: <20070522101830.t3yuycyqswosgw8k@webmail.leidinger.net> X-Priority: 3 (Normal) Date: Tue, 22 May 2007 10:18:30 +0200 From: Alexander Leidinger To: Hans Petter Selasky References: <200705212003.l4LK3xH8094270@repoman.freebsd.org> In-Reply-To: <200705212003.l4LK3xH8094270@repoman.freebsd.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8; DelSp="Yes"; format="flowed" Content-Disposition: inline Content-Transfer-Encoding: quoted-printable User-Agent: Internet Messaging Program (IMP) H3 (4.1.4) / FreeBSD-7.0 X-BPAnet-MailScanner-Information: Please contact the ISP for more information X-BPAnet-MailScanner: Found to be clean X-BPAnet-MailScanner-SpamCheck: not spam, SpamAssassin (not cached, score=-14.864, required 8, autolearn=not spam, BAYES_00 -15.00, DK_POLICY_SIGNSOME 0.00, FORGED_RCVD_HELO 0.14) X-BPAnet-MailScanner-From: alexander@leidinger.net X-Spam-Status: No Cc: Perforce Change Reviews Subject: Re: PERFORCE change 120191 for review X-BeenThere: p4-projects@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: p4 projects tree changes List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 22 May 2007 08:18:52 -0000 Quoting Hans Petter Selasky (from Mon, 21 May =20 2007 20:03:59 GMT): > http://perforce.freebsd.org/chv.cgi?CH=3D120191 > > Change 120191 by hselasky@hselasky_mini_itx on 2007/05/21 20:03:52 > > =09Add tons of documentation to my Linux USB emulation layer. You use a non-standard comment style. If you want to improve this, you can have a look at =20 dev/sound/pcm/mixer.c. For example the function mixer_get_recroute() =20 or mix_setrecdevs() has doxygen-style documentation (but =20 mixer_get_recroute() is missing an explanation for the route =20 parameter). It's not hard, just some minor reformatting. It also =20 serves as an example of good function documentation. If you use this kind of markup, you will not only get the =20 call/include-graph on a doxygen run, but also a nice API =20 documentation. If you use the "@internal" keyword =20 (http://www.stack.nl/~dimitri/doxygen/commands.html#cmdinternal), you =20 can mark a function as internal to your stack, the rest will be the =20 official API to use the USB stack. A doxygen command reference is at =20 http://www.stack.nl/~dimitri/doxygen/commands.html and the complete =20 documentation is available at =20 http://www.stack.nl/~dimitri/doxygen/manual.html for reading. A =20 downloadable version is available too (see the menu on the right side). Bye, Alexander. --=20 The first rule of intelligent tinkering is to save all the parts. =09=09-- Paul Erlich http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID =3D B0063FE7 http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID =3D 72077137