Date: Tue, 22 May 2007 10:18:30 +0200 From: Alexander Leidinger <Alexander@Leidinger.net> To: Hans Petter Selasky <hselasky@FreeBSD.org> Cc: Perforce Change Reviews <perforce@FreeBSD.org> Subject: Re: PERFORCE change 120191 for review Message-ID: <20070522101830.t3yuycyqswosgw8k@webmail.leidinger.net> In-Reply-To: <200705212003.l4LK3xH8094270@repoman.freebsd.org> References: <200705212003.l4LK3xH8094270@repoman.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
Quoting Hans Petter Selasky <hselasky@FreeBSD.org> (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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20070522101830.t3yuycyqswosgw8k>