Experimental Physics and
Industrial Control System

Steven M Beard <[email protected]> · Wed, 1 Apr 1998 09:25:28 +0100 (BST)

On Tue, 31 Mar 1998, Maren Purves wrote:

> Arun S, Bommannavar wrote:
> > On Tue, 31 Mar 1998 13:36:05 -0700, Rozelle Wright wrote:
> > >Hi Me,
> > >Sorting through documentation is sometimes a lot harder than sorting through
> > >the code.  At least with code you know what part of the system
> > >you should look at and you are sure it is up to date.
> > 
> >         I guess "Me" was speaking "in general" and not specifically
> > about "CA Server ". And I agree with "Me".
> 
> Hi all,
> 
> must say I agree with Rozelle here. Documentation is hardly ever up to 
> date, that's one, and then: I can grep code, most documentation I 
> cannot. Sometimes one needs to find things of which one doesn't know
> where to look.
> 
> My $0.02,
> 
> Maren

At this point I would like to plug William Lupton's ([email protected])
"wflman" utility. It can extract source code comments and convert them
into documentation, making it easier to keep the documentation and source
code in step with each other. The down side is that you have to structure
your comments in a particular way, so existing code would need work to
allow wflman to process it. I have found this utility really useful, and
it is worth considering for new projects. Last I knew, you could get a
copy via ftp from "ftp.keck.hawaii.edu/pub/wlupton".

Steven

==============================================================================
Steven Beard
Royal Observatory                  Tel.   : +44 (0)131 668 8253 (direct)
Blackford Hill                              +44 (0)131 668 8100 (switchboard)
Edinburgh EH9 3HJ                  Fax.   : +44 (0)131 668 1130
UK                                 E-mail : [email protected]       (Internet) 
                                   WWW    : http://www.roe.ac.uk/smbwww/

Experimental Physics and Industrial Control System

Experimental Physics and
Industrial Control System