Doxygen class formating...

Hey

I'd like to annotate my classes with a full info for each class... something like

(bare with me I just started to learn doxygen properly)

/**
* \class someClas
*
* \brief someClas Class intended for basic math
* \param mInt
* \param mOtherInt
* \param mVal
* \param someClass()
* \param ~someClass()
* \param doMath()
*/
class someClas : public otherClass {
int mInt;
/// \param userInt
int mOtherInt;
bool mVal;

public:
someClass();
~someClass()
///
/// \param x user in
/// \param y user alt in
void doMath(int x, int y);
}

 

can Clion somehow create the top comment for me with all content of it listed in order? I'm fairly sure /param is wrong key...

 

TIA

 

 

0

Please sign in to leave a comment.