2010-03-30 3 views
2

내 프로젝트 용 Doxygen 문서를 만들고 있습니다. 최근에 나는 \addtogroup 태그를 사용하여 관련 클래스를 그룹화했습니다. 이 후, 내 설명서에 모듈 탭이 있습니다. 모든 모듈을 보여줍니다. 동일한 페이지에 모듈 이름 아래에 모듈 이름 바로 아래에 설명을 추가하고 싶습니다. Doxygen을 사용하여 어떻게 할 수 있습니까?Doxygen 그룹 및 모듈 인덱스

은 여기 내 태그

에만 메모가 포함 된 전용 .H 파일을 작성해야
/*! \addtogroup test test 
* Test Testing a group in doxygen 
* @{ 
*/ 

답변

15

입니다.

/** @defgroup FooGroup 
* 
* This module does yada yada yada 
* 
*/ 

이 그럼 당신은 (심지어 다른 파일에) 그룹에 정의를 할당과 같은 :

/** @addtogroup FooGroup */ 
/*@{*/ 

/** Summon a goat 
* 
* @param name The name of the goat; 
* @return The summoned goat; 
*/ 
Goat summon_goat (const char *name); 

... 
... 

/*@}*/ 

편집 : 또한

각 그룹에 대해 은이 같은 코멘트를 정의 this는 어떻게되어 있습니다. "자세한 설명"을 참조하십시오. @verbatim@endverbatim 명령에 코드 스 니펫과 예제를 추가 할 수도 있습니다.

+4

"소환 염소"가 나를 부 .다. 그런데 SourceForge의 링크가 2011 년 9 월 28 일에 망가졌습니다. – Adrian

+0

@Adrian, 업데이트 된 링크. 신고 해 주셔서 감사합니다. – Dacav

+0

이렇게하려면 별도의 헤더 파일이 필요하지 않습니다. '@defgroup '을'@ addtogroup'과 같은 파일에 넣거나'@defgroup'을 전혀 가지지 않고 단지'@ addtogroup' 블록 중 하나에 넣을 수 있습니다 (그들은 이것에 대해서는'@ defgroup'). 트릭은 텍스트가 모듈의 페이지 상단 (그리고 모듈 색인 페이지)에 표시 되려면 간단한 설명 (예 :'@ brief') 만 있으면되고 다른 것은 'Detailed 설명 "을 클릭하십시오. – Foogod