2013-09-07 16 views
5

Próbuję udokumentować API C, które jest zawarte w jednym pliku nagłówkowym C. Kiedy uruchamiam doxygen na pliku, daje mi to błędy dla aktualnie nieudokumentowanych makr C, ale kiedy dodaję niezbędną dokumentację dla makr, chociaż nieudokumentowane błędy są wyczyszczone, makra plus dokumentacja nie pojawiają się w wygenerowanym doksygenowo wyjściu html.Dokumentacja nie pojawia się na wyjściu doxygen

Tylko ułamek udokumentowanego pliku nagłówkowego, struktury, faktycznie pojawia się w dowolnym wydruku doxygen. Nie widzę niczego w ustawieniach konfiguracyjnych ani dokumentacji, która pomogłaby w wyjaśnieniu, dlaczego doxygen nie umieszcza udokumentowanego kodu z pliku nagłówkowego na wygenerowanym wyjściu.

Czy ktoś wie, dlaczego tak się stało?

Odpowiedz

3

Zobacz punktach 2 i 3 FAQ: http://www.doxygen.org/manual/faq.html

W skrócie jesteś prawdopodobnie brakujących blok komentarz z @file dokumentowania plik nagłówka.

+0

Komentarz @file znajduje się w pliku i żadne z rozwiązań w faq nie ma znaczenia. Są napisane w sposób oparty na klasach, mówiąc o przestrzeniach nazw, ale ponieważ jestem prostym nagłówkiem C, co może wyjaśniać, dlaczego rozwiązania faq nie pomagają mi. – jwhitmore

+2

@ plik powinien zadziałać, więc proszę napisać samodzielny przykład (tutaj lub w narzędziu doxygen), aby samemu móc odtworzyć problem. – doxygen

+0

Ups! Plik @file dokumentuje znacznie więcej, w rzeczywistej dokumentacji pliku, ale naprawdę brakuje mi funkcji API. Niestety w nagłówku funkcje API są zadeklarowane jako wskaźniki C dla funkcji. Dokumentuję je za pomocą "\ fn", ale te nie pojawiają się wcale. – jwhitmore

Powiązane problemy