bug-hurd
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: continuing documentation


From: Gordon Matzigkeit
Subject: Re: continuing documentation
Date: 29 Jun 2001 16:04:44 -0600
User-agent: Gnus/5.0803 (Gnus v5.8.3) Emacs/20.7

>>>>> Thomas Bushnell, BSG writes:

 TBB> OKUJI Yoshinori <okuji@kuicr.kyoto-u.ac.jp> writes:
 >> For now, I'm afraid of two things about that. One of these is that
 >> people often write documents and comments differently, of course,
 >> intentionally.

 TBB> I agree with Okuji here.  The job of the comment in a header
 TBB> file is to remind a programmer what the interface is.  The job
 TBB> of the manual is to explain the interface.

Okay, I can agree with that.  The constraint I was operating under was
to give some way of indicating to a documentor when an interface
change has been made, and indicating to the coder when a description
has been clarified.

Perhaps just `diffmon' is good enough, and is already as specific as
possible.

-- 
 Gordon Matzigkeit <gord@fig.org>  //\ I'm a FIG (http://fig.org/)
Committed to freedom and diversity \// I use GNU (http://fig.org/gnu/)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]