This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC 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: Thoughts on doxygen for internal documentation


On Thu, 16 Jan 2003, Jeff Law wrote:

>  >Let me rephrase the question then.  Would it be OK to start
>  >documenting major functions and data structures with /** */
>  >instead of /* */?
>
> Same answer.  If /** is acceptable for the rest of the compiler
> proper, then I'd go with it on tree-ssa.  If it isn't acceptable,
> 
We are running around in circles.  You still have not given me
*your* opinion! :)

> I'll note that /** is contrary to the GNU coding standards.
> 
Yes, I know.  That's why I'm asking.  I need to gather opinions
on whether we should ammend the coding standards to request
comments starting with /** to make them more doxygen friendly.

Would people in this list endorse such a change to the coding
standards?

A meta question.  Is this the right forum to debate the issue?
If not, what is the process for making changes to the coding
standards?


Thanks.  Diego.


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