Doxygen不能正确确定返回类型

Doxygen does not properly determine return type

本文关键字:返回类型 不能 Doxygen      更新时间:2023-10-16

我有这个代码:

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

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