From: Marco <prenom_nomus@yahoo.com>
Subject: Re: Ada documentation tools.
Date: Mon, 20 Dec 2010 05:02:10 -0800 (PST)
Date: 2010-12-20T05:02:10-08:00 [thread overview]
Message-ID: <4f1d24ec-79df-4e12-8e40-11e591223e82@glegroupsg2000goo.googlegroups.com> (raw)
In-Reply-To: <sZqdnewQpeDSXnzRRVn_vwA@giganews.com>
On Monday, November 15, 2010 4:33:19 PM UTC-7, Peter C. Chapin wrote:
> Speaking of Doxygen... one thing that I rather like about it is that it
> allows you to include comments on either the declaration or the
> definition of a function. The Ada tools I've seen so far believe that
> all "documentation" comments should appear in the specification. I agree
> that is logically where they should go but from a maintenance point of
> view it can be nice to have the documentation for a subprogram right
> where one spends time editing that subprogram. I understand this invites
> confusion between documentation for users vs documentation for
> implementers.
Whitebox vs Blackbox is important - comments on the algorithm used for example belong in the body not the spec since it could change without affecting the caller
next prev parent reply other threads:[~2010-12-20 13:02 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-14 22:26 Ada documentation tools Peter C. Chapin
2010-11-15 8:14 ` AdaMagica
2010-11-15 9:49 ` Maciej Sobczak
2010-11-15 12:29 ` AdaMagica
2010-11-15 13:06 ` Maciej Sobczak
2010-11-15 14:25 ` AdaMagica
2010-11-15 14:56 ` Georg Bauhaus
2010-11-17 23:06 ` Yannick Duchêne (Hibou57)
2010-11-15 9:52 ` Georg Bauhaus
2010-11-15 11:40 ` Peter C. Chapin
2010-11-15 12:38 ` AdaMagica
2010-11-15 23:33 ` Peter C. Chapin
2010-12-20 13:02 ` Marco [this message]
2010-11-16 1:02 ` Marc A. Criley
2010-11-15 12:56 ` Niklas Holsti
2010-11-15 23:19 ` Peter C. Chapin
2010-11-15 9:47 ` Maciej Sobczak
replies disabled
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox