DoxyDoc icon indicating copy to clipboard operation
DoxyDoc copied to clipboard

Feature Request: Comment Style Preference

Open skharat8 opened this issue 9 years ago • 2 comments

It would be great if you could add a user option to choose the kind of comment style to use for the Doxygen comments.

The two options would be: /**

  • @brief
  • @detail */

OR

// /// @brief /// @detail //

The problem with the first style is when you try to comment a function along with the documented block, it doesn't work as expected : /*

/**

  • @brief
  • @detail */

void class::function(param) { }

*/

skharat8 avatar Apr 10 '15 21:04 skharat8

:+1:

KindDragon avatar Jun 18 '15 08:06 KindDragon

DoxyDoxygen is an alternative to DoxyDoc and it allow to choose your commenting style (and even more)...

This will unfortunatly probably not help to solve your use case... I'm not sure have correctly understand it: You really to comment a "comment" (that look like a function) ?

With DoxyDoxygen, want I want to update an existing comment, I simply press Alt+Q. Your example

///
/// blabla
/// 
void class_name::function(int param) {
}

after update, will result:

///
/// blabla
///
/// @param[in]  param  { parameter_description }
///
void class_name::function(int param) {
}

20Tauri avatar Aug 26 '15 19:08 20Tauri