Как я могу создать файл, который документирует только «публичные» API в Doxygen - PullRequest
Новая
       52

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

6 голосов
/ 12 ноября 2010

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

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

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

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

1 Ответ

8 голосов
/ 22 ноября 2010

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

  • Вы можете использовать тег \internal
  • Вы можете использовать *Тег 1009 *\private вместе с EXTRACT_PRIVATE=NO в докси-файле
  • и, возможно, другие, включающие одну из различных EXTRACT_ переменных конфигурации.
...