Doxygen python 链接到函数

Question

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

例如 ModuleName::Namespace 可以工作，但 ModuleName::Namespace::getSomething() 不行。

我如何让这些链接发挥作用？

Answer 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() 将自动链接。