Subject: Re: Adding to KNF.
To: Jason R Thorpe <thorpej@wasabisystems.com>
From: Simon J. Gerraty <sjg@crufty.net>
List: tech-kern
Date: 06/18/2002 01:31:20
> > What I'd like to suggest is that in going forward, we adopt some changes
> > to the KNF that require people to at least put more text in a comment
> > block prior to the function.

>If we're going to do something like this, then I suggest people take
>a look at doxygen (which can generate manual-type documentation from
>marked up comments in source files).

Wow the pkg dependencies are a bit much... but yes I've used this
approach for years and found it effective - mostly for scripts and such
where I inlcude the man page as a plain text comment which a perl
script can extract and render as troff etc.  
See http://www.crufty.net/cgi-bin/rtfm?topic=cmt2doc.pl

The script itself is at http://www.crufty.net/ftp/pub/sjg/cmt2doc.pl
(oops hadn't been updated since '98, just put the latest version there :-)

--sjg


>-- 
>        -- Jason R. Thorpe <thorpej@wasabisystems.com>