doxygen을 사용하여 Python 패키지 문서화

Question

http://www.stack.nl/~dimitri/doxygen/docblocks.html의 "Python의 특수 문서 블록"에는 Python을 사용한 doxygen 사용 예가 나와 있습니다.

doxygen (웹의 출력 예)에 의해 생성 된 해당 HTML 문서에서 패키지 이름을 클릭하면 패키지와 연결된 모든 설명, 클래스 및 기능이 표시됩니다.

doxygen 문서에서 동일한 예제 스크립트를 사용하여 "doxygen -g config"로 config 파일을 만들고 "doxygen config"로 html을 생성하면 출력이 다릅니다. 패키지 이름을 클릭하면 패키지 설명 만 표시되고 클래스 및 기능은 표시되지 않습니다.

패키지 문서에서 클래스 및 기능을 사용하려면 구성 파일이나 일부 XML 스키마에서 무엇을 변경해야합니까?

편집 1 :

## @package pyexample 
# Documentation for this module. 
# 
# More details. 

## Documentation for a function. 
# 
# More details. 
def func(): 
    pass 

## Documentation for a class. 
# 
# More details. 
class PyClass: 

    ## The constructor. 
    def __init__(self): 
     self._memVar = 0; 

    ## Documentation for a method. 
    # @param self The object pointer. 
    def PyMethod(self): 
     pass 

    ## A class variable. 
    classVar = 0; 

    ## @var _memVar 
    # a member variable 

편집 : 2 : 위의 웹 페이지에서 예를

Answer 1

doxygen이 문서의 예제-setup.exe를 doxygen이-1.7.4 윈 XP와를 사용하여 는 생성 된 다음 설정을 사용하십시오 :

PROJECT_NAME  = "Python" 
OUTPUT_DIRECTORY = pyexample 
GENERATE_LATEX = NO 
GENERATE_MAN  = NO 
GENERATE_RTF  = NO 
OPTIMIZE_OUTPUT_JAVA = YES 
INPUT    = pyexample.py 
QUIET    = YES 
JAVADOC_AUTOBRIEF = YES 
SEARCHENGINE  = NO 

doxygen 소스 패키지의 examples 디렉토리를 참조하십시오.