Doxygen 그룹을 사용하여 C 디렉토리 구조를 미러링하는 방법은 무엇입니까?

Question

C 코드에서 Doxygen을 사용하여 기본적인 도움이 필요합니다. 모든 기본적인 문서가 잘 나오고 있으며, 필자는 파일과 함수의 길고 긴 목록을 구조화하는 데 도움이 필요합니다.

src/ 
+--util/ 
    +--file1.h 
    +--file1.c 
    +--file2.h 
    +--file2.c 
+--stats/ 
    +--file3.h 
+--etc/ 

매우 표준 :

나는이처럼 보이는 C 소스 트리가 있습니다. 현재 doxygen은 모든 파일의 플랫 파일 목록을 생성합니다. 우리는 src /의 'dub-dir'을 '모듈'이라고 부릅니다. 따라서 이것을 문서화하는 것은 Doxygen 모듈/그룹에 적합합니다.

그룹화 명령을 사용하여 위의 디렉토리 구조를 정확히 미러링하는 방법은 무엇입니까? 나는 파일 1과 파일 2 문서에 링크 된 생성 된 문서에서 모듈 유틸리티를 갖고 싶다. JavaDoc은 패키지를 취급하는 것과 똑같습니다.

/addtogroup util을 추가하면 각 헤더 파일에 @ {tags는 모든 헤더 내의 모든 데이터 구조 등의 평평한 목록을 포함하는 미니 사이트를 생성했습니다. 이는 예상 한 것이거나 원하지 않은 것입니다. 아마도 이것은 doxygen 그룹이해야 할 일입니다. 즉, 코드가 여러 파일에 걸쳐 구현 될 때 API를 균일하게 문서화 할 수 있습니까?

Answer 1

모듈을 사용하는 더 간단한 옵션은 @page과 @subpage입니다. 당신의 설명 레이아웃에 비슷한 얻으려면 다음을 사용할 수

@page util Util 
This page describes util module. 
@subpage file1 
@subpage file2 

@page stats Stats 
This page describes stats module. 
@subpage file3 

@page etc 
Blah blah blah 

@page file1 File 1 
This is file 1. 

@page file2 File 2 
This is file 2. 

@page file3 File 3 
This is file 3. 

이 의견은 물론 하나 개의 파일 또는 여러에 포함 할 수 있습니다. 일반적으로 나는 file2.h에 @page file1을, file2.h에는 @page file2을 넣고, 더 많은 최상위 헤더 나 주 소스 파일에는 @subpage 주석을 넣습니다.