Doxygen无法正确确定返回类型

时间:2016-02-16 19:43:39

标签: c++ doxygen preprocessor-directive

我有这段代码:

#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版本。我不介意,如果上面的代码有点改变(只要功能当然相同)。

1 个答案:

答案 0 :(得分:1)

您只需将返回类型硬编码到注释中即可。它将具有标签[return](我认为)并且只有它可能的类型(int / void),然后在描述中包含原因。

相关问题