5
단일 C 헤더 파일에 모두 포함 된 C API를 문서화하려고합니다. 파일에 doxygen을 실행하면 현재 문서화되지 않은 C 매크로에 대한 오류가 발생하지만 매크로에 필요한 문서를 추가하면 문서화되지 않은 오류는 지워지지 만 매크로와 문서는 doxygen에서 생성 된 html 출력에 나타나지 않습니다.문서가 doxygen 출력에 나타나지 않습니다.
문서화 된 헤더 파일의 일부만 구조체가 실제로 모든 doxygen 출력에 나타납니다. doxygen이 헤더 파일의 문서화 된 코드를 생성 된 출력에 배치하지 않는 이유를 명확히하는 데 도움이되는 구성 설정이나 설명서에서 아무것도 볼 수 없습니다.
누구에게 이것이 왜 그런지 알 수 있습니까? 한마디로 http://www.doxygen.org/manual/faq.html
당신이 가능성이 헤더 파일을 문서화하는 @file에 코멘트 블록을 누락 :
@file 주석은 파일에 있으며, faq의 솔루션 중 어느 것도 차이를 만들어 내지 않습니다. 그것들은 네임 스페이스에 대해 이야기하는 클래스 기반의 방법으로 작성되었지만, 나는 바로 C 헤더이므로 faq 솔루션이 왜 도움이되지 않는지 설명 할 수 있습니다. – jwhitmore
@file이 효과가 있었으므로, 스스로 포함 된 예제 (여기 또는 doxygen의 버그 추적기)를 게시하여 문제를 스스로 재현 할 수 있도록하십시오. – doxygen
죄송합니다. @file은 실제 파일 문서에서 훨씬 더 많은 것을 다루지 만 실제로 실종 된 것은 API 함수입니다. 불행히도 헤더에서 API 함수는 함수에 대한 C 포인터로 선언됩니다. 나는 그들을 "\ fn"으로 문서화하고 있지만 이것들은 전혀 나타나지 않는다. – jwhitmore