Lars Thalmann wrote:

Hi! David, Chad Miller, and I had an IRC meeting on freenode#mysql-dev this morning to discuss how to move forward with the doxygen code merging. Here is a summary of what will be happening:

David will be working this week on a script which will "re-convert" the doxygen comments that make merge conflicts more prevalent, and streamline the doxygen-ifying to the following:

<Shrews> ok. so just to recap... <Shrews> remove all leading *'s from the comments.... <Shrews> split out @brief to a separate line.... (@details too?) <Shrews> anything else that would make merging easier? <chadmiller> Shrews: Yes, as few changes to the comment source as possible. A good test for how easy it is for others to swallow is "diff" against the current source, and if there are no unnecessary "-" and "+" then it's great. <chadmiller> The fewer lines changed, the less likely it is that the merge will conflict with someone else's changes. <Shrews> i'll see what i can do. there are going to be some -'s and +'s that we can't rid of this way, though <chadmiller> Agreed.

Chad has *already* changed the internals documentation to reflect that the new commenting going forward will be in the style of doxygen/javadoc comments:

http://dev.mysql.com/doc/internals/en/coding-guidelines-c.html

So, yes, Lars, please have your team begin using Doxygen comments for *new* code, and let the doxygen project team members handle existing code comments.

I will be working on doxygen code comment templates so that more and more folks can contribute to the effort.

Cheers,

Jay