This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [commit] cleanup stale exec.{h|c} xfer_memory comments.


> Is the convention to describe functions in headers?  That's reasonable
> for data structures, but we have a lot of functions documented right
> before their source, not in the headers.  I find the documentation in
> the .c files easier to use, because you don't need to consult another
> file.  This is C, not C++, so the interface and the implementation are
> not separated.

Unfortunately, I don't think we really have a hard convention in GDB.
For C, I also tend to prefer documenting the function next to the
implementation. It's the only way to be consistent, since some functions
do not have advance declarations.

-- 
Joel


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]