Как создать файл, который содержит только «публичные» API в Doxygen

Question

У меня есть проект, над которым я работаю, которая является библиотекой . Мне нужно документировать внутреннюю часть кода библиотеки для моих собственных целей, но также необходимо доставить документ API моим пользователям о том, как они должны использовать библиотеку.

Так, в документе я хотел бы дать им, я хочу, чтобы включить только «общественные» функции, структуры, переменные и т.д. - и не в внутренние одни.

Есть ли способ, которым я могу это сделать в Doxygen? Могу ли я определить, что такое «публичный» и «частный»? Могу ли я создать документ, который содержит только «общедоступный» API для моих пользователей, и отдельный с «частными» деталями дизайна для моего собственного использования?

ПРИМЕЧАНИЕ: Это прямой C, а не C++, и мое использование терминов «public» и «private» не имеет ничего общего с «публичными» и «частными» членами класса.

Answer 1

В зависимости от ваших потребностей, есть несколько способов сделать это:

• Вы можете использовать \internal тег
• Вы можете использовать \private тег вместе с EXTRACT_PRIVATE=NO в Doxyfile
• и, возможно, других, связанных с одна из различных конфигурационных переменных EXTRACT_.