2011-02-23 5 views
5

우리는 doxygen을 사용하여 클래스를 문서화합니다. 클래스가 생성자 및/또는 소멸자를 생성했음을 명시 적으로 문서화하고 싶습니다. 생성 된 복사 생성자를 사용하여 복사하는 것은 안전합니다. 그러나 constructor/destructor는 선언되지 않았으므로 doxygen은 문서가 어떤 함수에 속해 있는지 알지 못합니다. 함수가 선언되지 않은 경우에도 doxygen이 함수 주석을 포함하도록 만드는 방법이 있습니까?doxygen에서 생성자 생성자를 문서화하는 방법

//! The Foo class documentation 
class Foo { 
    //! @fn Foo(const Foo&) 
    //! Generated copy constructor OK to use 

    //! method documentation 
    void method(); 
} 

또한 생성 된 파일의 서명을 쓰고 싶지 않습니다.

다른 옵션은 클래스 헤더에 설명하는 것입니다. 다른 방법이 있습니까? 당신이 당신의 기본 생성자를 생성하기위한 C++ 0X에 소개 된 = 기본 개념을 사용하는 경우

+3

실제로 복사 생성자를 문서화 할 이유가 있습니까? 나는 그것이 무엇을하는지 분명히하고, 생성 된 생성자의 사용을 허용한다면 작성자로서 분명히 괜찮을 것입니다. –

+4

Doxygen과 같은 도구가 유용한 문서를 만들 수없는 이유에 대한 좋은 예입니다. 클래스를 복사 할 수 있다고 사용자에게 알립니다. – jalf

답변

관련 문제