Change doxygen comment style in Eclipse

Question

Does anyone know how to edit the style used for Doxygen comments in Eclipse CDT?

In other words type /** and pressing enter on a line before a function curren

Answer 1

A Doxygen tag uses this basic format.

/**
Your tags and such. It MUST have the /** and the */.
*/

It absolutely must have the /** */ around the whole Doxygen comment. If you modify the Code Templates it will do what you want.

The proposed comment style is wrong though.

/***************/ <-- These are terminated Doxygen blocks.
/// <-- These are used in xml style Doxygen blocks.
///
/// This isn't actually a Doxygen block and shouldn't work
/// if you run Doxygen on it.
///
/***************/ <-- These are terminated Doxygen blocks.

This below is standard for most companies who code in JAVA and eclipse. Since Doxygen is valid for multiple languages this is valid for C/C++ too.

/**
 * Brief description.
 *
 * @param[in|out]  
 */

If you want to use the xml style tags...

/// 

/// This is a summary of the class, blah, blah.
/// 

You're also going to want to make sure eclipse isn't inserting other comment styles too, otherwise you can end up with comments inserted inside other comments. Also generally it is a bad rule to mix comment styles like /** */ and ///.

Finally if you select auto-generate comments when you create classes and such those comments will automatically be put in. And you can have eclipse auto-generate method headers as you type (though I forget how I did this).