Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Comment Style Preference #5

Open
skharat8 opened this issue Apr 10, 2015 · 2 comments
Open

Feature Request: Comment Style Preference #5

skharat8 opened this issue Apr 10, 2015 · 2 comments

Comments

@skharat8
Copy link

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:
/**

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 :
/*

/**

void class::function(param) {
}

*/

@skharat8 skharat8 changed the title Feature: Comment Style Preference Feature Request: Comment Style Preference Apr 10, 2015
@KindDragon
Copy link

👍

@20Tauri
Copy link

20Tauri commented Aug 26, 2015

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) {
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants