Doxygen을 처음 사용하고 있으며 소스를 공개 할 API를 문서화하려고합니다. API의 최종 사용자 및 수정하려는 사용자를 위해 두 세트의 문서를 작성하고 싶습니다. "user"와 "dev"문서 트리를 생성 할 수있는 방법으로 Doxygen 주석 블록을 태그하는 방법이 있습니까? 내 문제에 대한 더 나은 해결책이 있습니까? 감사!Doxygen을 사용하여 동일한 코드베이스에서 "사용자"및 "개발자"문서 생성
코드 구조에 따라 별도의 소스 파일을 포함하는 두 개의 Doxygen 구성 파일을 사용할 수 있습니다. "사용자"구성 파일은 API에 대한 공용 인터페이스가 포함 된 소스 파일 만 나열하고 "dev"구성 파일은 전체 프로젝트의 모든 소스 파일을 나열합니다.
이것은 모든 사용자 인터페이스 (예 : 추상 기본 클래스)는 사용자를 염두에두고 문서화해야하지만, 일반적으로 정의에 따르면 추상적 인 기반에서 구현 세부 사항이 될 가능성이 거의 없음을 의미합니다 수업.
모든 "dev"문서는 인터페이스를 구현하는 실제 클래스에 있습니다. 인터페이스는 API에서 결코 볼 수 없으며 "user"Doxygen 구성 파일로 안전하게 생략 할 수 있습니다.
코드가 이런 식으로 구성되지 않으면 작동하지 않을 것입니다. 따라서 생각해 볼 수있는 유일한 해결책은 사용자의 의견을 conditional statements으로 채우는 것입니다.
Malvineous가 이미 말했던 것 외에도 \internal doxygen 명령이 있습니다. http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal
\internal는 숨기거나 Doxyfile
더 많은 정보 INTERNAL_DOCS을 변경하여 문서의 일부를 표시 할 수 있습니다