Doxygen private function

Question

doxygen이 개인용 함수에 대한 문서를 보여줄 수있는 방법이 있습니까? 나는 doxygen이 사적 기능의 대다수에 대한 문서를 보여주지는 않지만 선택된 몇 가지 개인 기능을 위해 그것을 보여주기를 바란다. 필자의 동기는이 C++ 개인 함수가 파이썬에 확장 기능으로 제공되고 그 문서가 Doxygen에 나타나기를 바랍니다. 그러나 나는 수업이 필요하기 때문에 공개하지 않기를 바란다. 그들은 분명히 민간 부문에 속해있다.

감사합니다.

Answer 1

이것을 달성하는 데는 몇 가지 방법이 있습니다.

표시하지 않으려는 기능을 단순히 문서화 할 수 없습니다. 기본적으로 Doxygen은 사용자가 문서화하지 않은 회원을 표시하지 않습니다. 따라서, 당신은 비공개를 보여주기 위해 그것을 말할 수 있으며, 서류 미비 개인 회원은 보이지 않을 것입니다.

Answer 2

ENABLED_SECTIONS 구성 옵션에 섹션 레이블을 추가하여 \ cond와 \ endcond 명령 사이의 섹션을 포함 할 수 있습니다. 섹션 레이블을 생략하면 섹션이 무조건 처리에서 제외됩니다.

/** An interface */ 
class Intf 
{ 
    public: 
    /** A method */ 
    virtual void func() = 0; 

    /// @cond COND1 

    /** A method used for testing */ 
    virtual void test() = 0; 

    /// @endcond 
}; 

는

cond help이 COND1 섹션을 볼 수 없음 참조 : 단지 ENABLED_SECTIONS 구성 옵션에 추가하지 않습니다.