On Fri, Jan 26, 2001 at 01:09:30PM -0800, Paul Rohr wrote:
> I'll toss my penny in the pot to vote with Dom here.  The three times I use 
> header files are:
> 
>   - to get an overview of what that module does
>   - as a quick API reference 
>   - to change them  ;-)
> 
> This is all the more true now that we've got Doxygen going.  If anyone wants 
> to see comments interspersed with function prototypes, that's where they 
> should look. 
> 
> Dom's also got a excellent point that the implementations and docs are more 
> likely to stay in sync if they're immediately adjacent.  

And Jesper wrote:
> So unless more people weigh in on their side of the argument, I guess
> I should be reversing the change... John/Sam - what do you think of
> Paul's arguments?

Yeah, it's fine with me.  I guess I'm still coming from a strongly
"newbie" perspective which you will have to forgive me for.  I still
don't know 1/20th of the functions available to me for use, and so
naturally I turn to the header files to find out what functions are
available.  I have also been using lxr a lot, and it takes a good bit
for those cpp files to load.  ;-)  

Your arguments definitely make sense, though, and I think are more
practical in the long run.

Take care,

        John

Reply via email to