在python函数中使用\ return命令

时间:2013-07-04 17:46:53

标签: python doxygen

我正在尝试在我的python代码中记录一个函数,并希望包含\return命令。让我们这样说:

## \file
# File description

## Function to show you the problem.
#
# \return boolean True
def retTrue():
  return True

当我对此运行doxygen时,它会在相应的文件中创建一个条目,但它只是将文本"Function to show you the problem."放在函数旁边。函数本身未链接,并且未使用\return命令。

如果我设置EXTRACT_ALL = YES它有效(意味着函数名称已链接,并且描述块也显示了返回文本),但我确信有一种更优雅的方式来完成此操作而不必列出的项目文件。

我尝试了\return一个类方法,它立即起作用,所以我想我无法弄清楚哪个是正确的选项。其他EXTRACT_选项对我不起作用。

如果有人能告诉我神奇的设置,我真的很感激。

0 个答案:

没有答案