[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/)
- Re: continuing documentation, (continued)
- Re: continuing documentation, OKUJI Yoshinori, 2001/06/21
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/21
- Re: continuing documentation, Roland McGrath, 2001/06/21
- Re: continuing documentation, OKUJI Yoshinori, 2001/06/21
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/22
- Re: continuing documentation, OKUJI Yoshinori, 2001/06/23
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/23
- Re: continuing documentation, Maurizio Boriani, 2001/06/26
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/28
- Re: continuing documentation, Thomas Bushnell, BSG, 2001/06/29
- Re: continuing documentation,
Gordon Matzigkeit <=
- RE: continuing documentation, Jim Franklin, 2001/06/30
- Re: continuing documentation, Bill White, 2001/06/21
RE: continuing documentation, Chen Shapira, 2001/06/21