Quoting John-Mark Gurney <[EMAIL PROTECTED]> (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 _______________________________________________ [email protected] mailing list http://lists.freebsd.org/mailman/listinfo/cvs-all To unsubscribe, send any mail to "[EMAIL PROTECTED]"
