Re: [Corelinux-develop] Comments and documentation

[Frank V. C. <fr...@co...>]

Christophe Prud'homme wrote:

> On Wednesday 15 November 2000 14:57, you wrote:
> > Christophe introduced a new form of documentation for code (headers and
> > modules).
> >
> > A couple of issues with this
> >
> > 1. It is not consistent with the majority of the code and makes
> > readability a problem.
> > 2. By including all the source code and all the headers, documentation
> > is growing and is redundant.
> >
> > Thoughts?
> change the doxygen configuration file
> do not include headers and source code
> I don't remember the exact name of the options but you should be able to find
> it easily (look for SOURCE/CODE and HEADER)

What about the syntax of using
/*!
*/

in the headers?

BTW: It is my intent to open this for discussion, not to abolish. I was pointing
out the downsides. Is there a happy medium?

>
>
> C.
> --
> Christophe Prud'homme
> MIT -- 77 Mass Ave
> 02215 Cambridge MA
> _______________________________________________
> Corelinux-develop mailing list
> Cor...@li...
> http://lists.sourceforge.net/mailman/listinfo/corelinux-develop