我正在使用Doxygen来记录我的python模块,并且我试图让它链接到文本中的函数。我可以将它链接到函数的命名空间ok,但不能链接到函数本身。
E.g。 ModuleName::Namespace
有效但ModuleName::Namespace::getSomething()
没有。
如何让这些链接生效?
答案 0 :(得分:5)
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()将自动链接。