2013-04-30 2 views
0

내 C++ 응용 프로그램에는 특정 '동작'을 정의하는 약 10 개의 클래스가 있습니다 (A, B, C, ...). 코드의 다른 장소 (메서드)는 이러한 동작을 임의의 조합으로 사용할 수 있습니다. 예 : I는 명확한 개요를 생성 할Doxygen에 '참조 테이블'추가

BehaviorCollection coll; 
BehaviorA ba; 
coll.push_back(&ba); 
BehaviorB bb; 
coll.push_back(&bb); 
someComplexFunctionality (coll); 

: 방법 M1은 동작 A 및 B를 사용하여, 방법 M2가 동작 A, C 및 D, ... 실제로

코드 이런 비슷 사용 내가 하드 코드 목록을하지만 후에 때문에 오래된 될 것입니다 동안 수

BehaviorA is used by the following methods: 
- method1 
- method3 
- method7 

: 모든 행동의 클래스 문서와 같은 목록을 포함하도록 방법은, 바람직하게는 특정 행동의 문서에, 행동을 사용 새로운 메소드가 추가되고, 메소드가 추가로 사용하기 시작합니다. 행동 또는 방법은 행동을 사용하지 않습니다. 이렇게 유지할 수있게하려면 Doxygen에게 "이 코드는 이러한 동작을 사용하므로 해당 동작에 대한 문서에 무언가를 추가하십시오"라는 동작을 사용하여 메서드에서 무언가를 얻는 것을 선호합니다.

"Visual AssistX"또는 "C/C++ 용 이해"와 같은 도구를 사용하면 조회를 수행 할 수 있지만 조회를 수행 할 때마다 여전히 수동 작업이 필요합니다. 따라서 필자는 문서 생성 시스템에서이를 자동화하려고합니다.

defgroup 및 ingroup 사용을 고려하고 있지만 코드 조각이 작동하는지 잘 모르겠습니다. 가장 좋은 접근 방법은 무엇입니까?

답변

1

xrefitem 태그를 사용하여 해결책을 찾았습니다.

//! \xrefitem group_behaviorA_users "Behavior A users" "Behavior A Users" 

그리고 동작 자체는 이런 문서 광고 포함 : 해결

See \ref group_behaviorA_users for an overview of all users of this behavior. 

문제 행동을 이용하여 각 방법에서

는 I는이 같은 라인을 추가했다.