I know that a signal is just a function so the issue is not with documenting the signal itself. Imagine the following body of the function bar()
:
void MyFooBar::bar(int x) {
if(x < 0) emit fooLess();
else if(x > 0) emit fooGreater();
else emit fooZero();
}
I would like to know if there is a common way of document signal emission. Currently I'm thinking about using a list:
/**
* @brief Does something and emits the following signals
* @param x Depending on its value following signals can be emitted:
* * fooLess - if x is less than 0
* * fooGreater - if x is greater than 0
* * fooZero - if x is equal to 0
*/
void bar(int x);
Obviously this is just an example. I'm looking for something like
/**
* @brief Does something and emits the following signals
* @param x A value of some sort
* @emit fooLess If x < 0
* @emit fooGreater If x > 0
* @emit fooZero If x = 0
*/
but obviously this isn't present as a tag in doxygen since it's too language-specific.