Subject: Re: commit - doxygen comments, new layout - please look
From: Jesper Skov (jskov@redhat.com)
Date: Fri Jan 26 2001 - 17:08:55 CST
>>>>> "John" == John L Clark <jlc6@po.cwru.edu> writes:
John> I have a couple questions about the actual content of the
John> comments, too. When should it be necessary to use the \return
John> doxygen structure? For example, why do you have the line
John> `\return Type' in the comments for getType()? What information
John> does that provide that looking at the code doesn't?
Look at the HTML output - here for another function:
Parameters:
x
X coordinate of point
y
Y coordinate of point
Returns:
Distance between container's circumference and point
The fact that there's not more words to it than "Type" does not mean
that it should be omitted.
Following your reasoning (to the limit) documentation wouldn't be
necessary - it doesn't provide any information that the code doesn't
:)
Jesper
This archive was generated by hypermail 2b25 : Fri Jan 26 2001 - 17:09:00 CST