Re: [evolution-patches] More API docs -- e-time-utils and e-xml-hash-utils

[James Bowes <bowes cs dal ca>]

On Mon, 2005-03-28 at 13:52 -0500, Jeffrey Stedfast wrote:
> why shouldn't the TITLE and stuff be in the sections file? I would
> prefer it there rather than in the c files (those particular comments
> are just clutter)
> 

Having it directly in the C code will probably mean that the
documentation will be less likely to get out of sync with the actual
code. A lot of the source files already seem to have a short description
anyways, so this isn't too much more clutter. And, so long as there's
nothing explicitly added to the SGML template files, then they won't
have to be kept in CVS.

I'm not particularly tied to this way though, so if someone tells me to
put the section stuff back into separate files, I'll do that.

-James