Doxygen 无法正确确定返回类型

Question

我有这个代码：

#if PY_MAJOR_VERSION >= 3
int
#else
void
#endif
init_numpy()
{
    import_array();
}

这并不漂亮，但这不是我遇到的问题（这里讨论了此代码的原因https://mail.scipy.org/pipermail/numpy-discussion/2010-December/054357.html）。

我遇到的问题是，如果我在上面添加这样的 doxygen 评论：

/*! \brief some function
*
*/
#if PY_MAJOR_VERSION >= 3
...

Doxygen 假定此方法的返回类型为 void。一般来说，这当然不是真的。

问题

有没有一种方法可以获得正确的文档，即返回类型取决于所使用的 Python 版本。我不介意，如果上面的代码稍作改动（当然只要功能相同）。

Answer 1

您可以将返回类型硬编码到注释中。它将有标签 [return]（我认为）并且只有它可能是的类型（int/void），然后在描述中包含原因。