doxygen을 사용하여 파이썬 프로젝트를 문서화하고 있습니다. 내 설정 파일을 만들고 In/Out Directory를 설정했는데 그게 전부 였어. 설명서를 생성 할 때 클래스 및 클래스 계층 구조를 추출하지만 기능이있는 모듈은 추출하지 않습니다.Doxygen은 파이썬을 사용하여 파일에 대한 메소드 설명을 추출하지 않습니다.
마찬가지로, 올바른 주석 구문으로 문서화 한 주 기능 세트가있는 .py 파일이 있지만이 함수는 설명서에 전혀 나와 있지 않습니다. 왜 이런거야?
기본 doxygen 구성에서는 모듈 또는 모듈이 문서화되어있는 경우에만 모듈 수준 기능이 문서화됩니다.
##
# My function
#
def func():
pass
이 파일을 문서화하지 않는 문서화되지 않습니다
: 예를 들어##
# @file
# File documentation
#
또는 모듈이 설명되어 있습니다
Doxygen을 파이썬 코드를 문서화하는 방법에 대한 자세한 내용은##
# @package MyModule Module documentation
#
, http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks을 참조하십시오.
Doxygen은 주석에 특별한 명령을 지원하지 않으므로 파이톤'' "''을 사용하여 파일/모듈을 문서화 할 수 없습니다. –
# EXTRACT_ALL 태그가 YES로 설정된 경우 doxygen은 문서가없는 경우에도 # 설명서의 모든 항목을 문서화한다고 가정합니다. # 개인 클래스 멤버와 정적 파일 회원은 EXTRACT_PRIVATE #하지 않는 숨겨지고 EXTRACT_STATIC 태그는 EXTRACT_PRIVATE 태그가 클래스의 모든 개인 회원 YES로 설정되어있는 경우 가 EXTRACT_ALL = YES #이 #이 될 것입니다 YES로 설정 문서에 포함되어 있습니다. EXTRACT_PRIVATE = YES –
"아니오"를 예로 변경했습니다. 문제 해결 ...이 질문을 어떻게 닫아야할지 모르겠다. –
Colton, 답으로 솔루션을 게시 한 다음 수락하십시오. – smci