Re: Thoughts on doxygen for internal documentation

[Diego Novillo <dnovillo at redhat dot com>]

On Thu, 16 Jan 2003, Jeff Law wrote:

> Actually, I wouldn't go with doxygen stuff at all unless it's been
> OK'd for the rest of the compiler proper.
> 
Oh, well, OK.  In reality all I we *really* need is to delimit
comments with /** */.  All the rest is up to doxygen to figure
out.  So, even if the comments are not delimited with /** */,
doxygen is still useful.

Let me rephrase the question then.  Would it be OK to start
documenting major functions and data structures with /** */
instead of /* */?

I will still request its usage in tree-ssa-branch.  If the final
decision is not to use the additional '*' in comments, a sed
script can easily remove them from the tree-ssa files before we
merge to mainline.


Thanks.  Diego.