Создание документации для пользователей и разработчиков из одной и той же кодовой базы с использованием Doxygen - PullRequest
3 голосов
/ 04 августа 2011

Я новичок в Doxygen и пытаюсь задокументировать API, который планирую открыть с открытым исходным кодом. Мне бы очень хотелось создать два комплекта документации: один для конечных пользователей API и один для тех, кто намеревается его изменить. Есть ли способ пометить блоки комментариев Doxygen таким образом, чтобы я мог генерировать «пользовательские» и «dev» деревья документации? Есть ли лучшее решение моей проблемы? Спасибо!

Ответы [ 2 ]

3 голосов
/ 04 августа 2011

В зависимости от того, как структурирован ваш код, вы можете избежать использования двух конфигурационных файлов Doxygen, каждый из которых содержит отдельные исходные файлы.В файле конфигурации «user» будут перечислены только исходные файлы, содержащие открытый интерфейс API, а в файле конфигурации «dev» перечислены все исходные файлы для всего проекта.

Это означает, что все ваши интерфейсы(например, абстрактные базовые классы) необходимо будет задокументировать с учетом интересов пользователя, но обычно это не проблема, поскольку по определению вряд ли будут какие-либо подробности реализации в абстрактном базовом классе.

Все ваши "Документация dev затем помещается в фактические классы, реализующие интерфейсы, которые никогда не видны API и могут быть безопасно опущены "пользовательским" файлом конфигурации Doxygen.

Конечно, если ваш код не структурирован, этотак как это не сработает, так что единственное решение, которое я могу придумать, это заполнить ваши комментарии кучей условных выражений .

0 голосов
/ 29 октября 2013

В дополнение к тому, что Мальвинус уже сказал, есть команда \internal doxygen.

\internal позволяет скрыть или показать часть документации, изменив INTERNAL_DOCS в Doxyfile

Больше информации здесь: http://www.doxygen.nl/manual/commands.html#cmdinternal

...