Re: EPICS source Documentation

[Andrew Johnson <anj@aps.anl.gov>]

David Dudley wrote:
> I will agree, "... Code always tells the truth.  Comments sometimes
> do not...". However, a little comment block here and there, saying
> something along the line of "... in this block, the code is intended
> to do <such - and -such...>, that sort of points you in the direction
> of where you want to go, even if the comment is not 100% direct,
> would be useful most of the time.

I agree with you completely David, although I have just come across a 
counter example which illustrates one of Bob's points: Inside the 
base/src/libCom/osi/os/vxWorks/devLibOSD.c file there are two identical 
comments that say:

    /*
     * this global variable exists in the nivxi library
     */

There are no global variables used in the two routines containing the 
comment, and the code has nothing to do with any National Instruments' 
VXI library anyway!

- Andrew
--
There is considerable overlap between the intelligence of the smartest
bears and the dumbest tourists -- Yosemite National Park Ranger