如何记录doxygen中发出的Qt信号?

时间:2017-02-15 08:27:53

标签: qt doxygen signals-slots code-documentation

我知道信号只是一个功能所以问题不在于记录信号本身。想象一下函数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 个答案:

没有答案