Jak mogę utworzyć plik, który dokumentuje tylko "publiczne" API w Doxygen

Question

Mam projekt, nad którym pracuję, czyli bibliotekę . Muszę udokumentować elementy wewnętrzne kodu biblioteki dla własnych celów, ale muszę również dostarczyć dokument API do moich użytkowników, w jaki sposób powinni korzystać z biblioteki.

więc w dokumencie pragnę dać do nich, chcę to tylko funkcje „publiczne”, struktury, zmienne itp - i nie się wewnętrzne jedynek.

Czy mogę to zrobić w Doxygen? Czy mogę określić, co jest "publiczne", a co "prywatne"? Czy mogę wygenerować dokument, który zawiera tylko "publiczny" interfejs API dla moich użytkowników i osobny z "prywatnymi" detalami do mojego własnego użytku?

UWAGA: To jest proste C, nie C++ - a moje użycie terminów "publiczny" i "prywatny" nie ma nic wspólnego z "publicznymi" i "prywatnymi" członkami klasy.

Answer 1

W zależności od potrzeb, istnieje kilka sposobów, aby to zrobić:

• Można używać \internal tag
• Można użyć tagu \private wraz z EXTRACT_PRIVATE=NO w doxyfile
• i prawdopodobnie innych udziałem jedną z różnych zmiennych konfiguracyjnych EXTRACT_.