함수에 연결하는 Doxygen 파이썬

Question

파이썬 모듈을 문서화하기 위해 Doxygen을 사용하고 있으며, 함수 내 텍스트에 링크하려고합니다. 함수의 네임 스페이스에 연결할 수는 있지만 함수 자체에는 연결할 수 없습니다.

예. ModuleName::Namespace은 작동하지만 ModuleName::Namespace::getSomething()은 그렇지 않습니다.

어떻게 이러한 링크가 작동합니까?

Answer 1

Doxygen은 모듈 당 네임 스페이스의 함수를 자동으로 래핑합니다. 문서를 보거나 링크 할 수있게하려면이 모듈을 문서화해야합니다 (또는 EXTRACT_ALL = YES를 사용하십시오).

## @package another 
# 
# Another module 

import func 

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

당신은 그 foo는()와 func.foo를 (볼 수)가 자동으로 연결됩니다

여기에 예를 들어 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입니다.