2011-09-12 5 views
4

doxygen 형식의 C++ 클래스 주석을 업데이트했으며 멋지게 보이지만 ... 네임 스페이스 목록/탭이 전혀 유용하지 않습니다. 부모 이름 공간이 john 인 경우 각 라이브러리 또는 기능 영역에 대한 하위 네임 스페이스 예 : john::graphics, john::sound 등 Doxygen은 하나의 네임 스페이스 : john 만 나열합니다. 일부 설정을 간단히 변경해야합니까, 아니면 doxygen에서 가져 오기 위해 내 네임 스페이스를 문서화해야합니까?중첩 된 네임 스페이스가 표시되지 않는 Doxygen

+0

참조를 내 게시물 : http://stackoverflow.com/questions/2275601/documenting-namespaces -with-doxygen 가능한 복제본. –

답변

5

일반적으로 Doxygen이 중요하다고 결정할 수있는 사항을 문서화해야합니다. 네임 스페이스가 포함되어 있습니다. 그러나 당신은 그들을 잘 문서화 할 필요가 없습니다. Doxygen이 문서를 작성하는 데에는 이들이 사용하는 것에 대한 간단한 표기만으로 충분합니다.

+0

하지만 네임 스페이스는 문서화 된 클래스를 포함합니다 ... 네임 스페이스로 나열하면 코드를 탐색하는 분명한 방법이기 때문에 이상하게 보입니다. 오 잘 ... –

+2

@ 존 : 내가 말했듯이, 그것은 독시겐이 작동하는 방식이다 : 문서화되지 않은 것을 건너 뛰고 문서화되지 않은 것에 담긴 내용은 무시한다. 예를 들어 전역 함수가있는 경우 전역 함수를 정의한 파일이 문서화되어 있거나 모듈의 일부가 아닌 경우에는 전역 함수가 표시되지 않습니다. –

4

나는 Doxygen이 네임 스페이스가 중첩 된 것을 보지 못했던 비슷한 문제가있었습니다.

전에 :

/** 
* @namespace outer 
* @brief the outer namespace 
*/ 
namespace outer 
{ 
    /** 
    * @namespace inner 
    * @brief the inner namespace 
    */ 
    namepsace inner 
    { 
    } 
} 

후 : 내가 범위를 지정하여 고정

/** 
* @namespace outer 
* @brief the outer namespace 
*/ 
namespace outer 
{ 
    /** 
    * @namespace outer::inner 
    * @brief the inner namespace 
    */ 
    namespace inner 
    { 
    } 
} 
관련 문제