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()会自动链接在一起。