Re: commit - doxygen comments, new layout - please look


Subject: Re: commit - doxygen comments, new layout - please look
From: Sam TH (sam@uchicago.edu)
Date: Fri Jan 26 2001 - 17:51:50 CST


On Fri, Jan 26, 2001 at 06:46:35PM -0500, Randy Kramer wrote:
> Maybe we are thinking of different kinds of comments. I
> > have been thinking of these as comments that users of the function
> > would want. Are other people thinking of them as comments about the
> > implementation of the functions?
>
> Well, just to add my 2 cents, both kinds of comments are appropriate
> aren't they?
>
> Any maybe the comments for the users of the functions belong in the
> header files and those for implementation of the functions belong in the
> source files.

Not sure here. It seems other people have strong opinions on this, so
I'll defer to them.

>
> Then, it would be nice if Doxygen could let you look at either or both
> sets (types) of comments. Maybe Doxygen does allow that?

I don't know. You would have to ask Jesper (or Doxygen.org).
           
        sam th
        sam@uchicago.edu
        http://www.abisource.com/~sam/
        GnuPG Key:
        http://www.abisource.com/~sam/key




This archive was generated by hypermail 2b25 : Fri Jan 26 2001 - 17:52:47 CST