Как документировать испускаемые сигналы Qt в doxygen?

Я знаю, что сигнал - это просто функция, поэтому проблема не в документировании самого сигнала. Представьте себе следующее тело функции bar():

void MyFooBar::bar(int x) {
  if(x < 0) emit fooLess();
  else if(x > 0) emit fooGreater();
  else emit fooZero();
}

Я хотел бы знать, есть ли общий способ передачи сигнала документа. В настоящее время я думаю об использовании списка:

/**
  * @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);

Очевидно, это всего лишь пример. Я ищу что-то вроде

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

но очевидно, что это не тег в doxygen, так как он слишком специфичен для языка.

0 ответов

Другие вопросы по тегам