여러 파일에 걸쳐있는 네임 스페이스 문서화 doxygen

Question

고려해야 할 헤더 파일이 2 개 있습니다.

Doxygen을 함께 문서화 할 때 나는이 문제를 처리하는 방법을

// HEADER 2 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class That {...}; 
} 

// HEADER 1 
/** 
* Doc for Foo here? 
*/ 
namespace Foo { 
    class This {...}; 
} 

& &?

Answer 1

어느 쪽이든 다를 수 있습니다.

예를 들어 "<root>/utility/header1.hpp"의 내용이 namespace utility이고 "<root>/utility/header2.hpp" 인 경우를 상상해보십시오.

파일을 추가하여 유틸리티 네임 스페이스를 설명하는 "<root>/utility.hpp" 파일을 추가 할 수 있습니다. 실수로 포함되지 않도록 상단의 #error Documentation only.에 넣을 수 있습니다.

하지만 적어도

Answer 2

이 문서에 가장 적합한 장소를 찾기 (무작위로 어떤 클래스에 혼합되지.) 온전한 장소에 보관하는 일부 아웃 오브 방식으로 파일을 만드는 것이 좋습니다, 그 파일들 중 하나에 있건 완전히 다른 파일에 있든 상관 없습니다. Doxygen을의 네임 스페이스 태그로 주석 블록을 사용하여 여기

/** 
* @namespace Foo 
* Documentation for Foo here. More docs for Foo here, 
* and down here. 
*/ 

문서가 : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace