Doxygen python链接到函数

【问题标题】：Doxygen python linking to functionsDoxygen python链接到函数
【发布时间】：2011-12-04 13:30:06
【问题描述】：

我正在使用 Doxygen 来记录我的 python 模块，并试图让它链接到文本中的函数。我可以让它链接到函数的命名空间，但不能链接到函数本身。

例如ModuleName::Namespace 有效，但 ModuleName::Namespace::getSomething() 无效。

如何使这些链接正常工作？

【问题讨论】：

标签： python documentation module namespaces doxygen

【解决方案1】：

Doxygen 自动将函数包装在每个模块的命名空间中。您必须记录此模块以使文档可见和可链接（或使用 EXTRACT_ALL = YES）。

这是一个例子func.py

## @package func
#  Module docs

## A function
#
#  More documentation.
def foo():
    print "Hello World!"

## Another function.
#
#  This function simply calls foo()
def bar():
    foo()

还有另一个函数another.py：

## @package another
#
#  Another module

import func

## This function calls func.foo()
def another():
     foo()

您应该看到 foo() 和 func.foo() 将自动链接。

【讨论】：

我也成功使用了@namespace