Re: commit - AbiWord Doxygen primer & style guide


Subject: Re: commit - AbiWord Doxygen primer & style guide
From: Jesper Skov (jskov@redhat.com)
Date: Fri Jan 26 2001 - 01:07:10 CST


>>>>> "John" == John L Clark <jlc6@po.cwru.edu> writes:

John> There's one point in your brief style guide that I would like to
John> generally discuss on the list. That would be point 4:

John> Put the descriptions by the function definition, not the
John> declaration (except inline accessors defined in the header
John> files).

John> My first inclination is to disagree, although there is likely
John> some point here that I'm missing. It seems to me that
John> descriptions should be put with the function definitions, in
John> header files. The header file is by definition supposed to
John> contain interface information, both for the rest of your code
John> and the compiler, but also for the developer.

[snip]

Good arguments, I guess. I don't use header files very often - but
when I do it's to find a particular functionality and the comment
would be nice to have there.

Let's change it.

Jesper



This archive was generated by hypermail 2b25 : Fri Jan 26 2001 - 01:07:31 CST