Doxygen для проекта, управляемого с помощью git?
Я работаю над проектом C ++ и Objective C iPhone. Я использую git в качестве своей системы контроля версий.
Кодовая база немного выросла, поэтому я хотел бы добавить в проект doxygen . Проблема в том, что я я не смогу увидеть сгенерированный Doxygen HTML-документ, если я не загрузил его отдельно)
Может быть, я мог бы сделать какое-нибудь cron-job , чтобы обновлять doxygen на стороне сервера?
Справка очень приветствуется.
1 ответ
Я считаю, что никогда не следует хранить сгенерированные файлы в исходном репозитории, особенно когда они генерируются общедоступными инструментами, такими как Doxygen, из файлов, которые уже хранятся в репозиторий. В случае с Doxygen вам нужно только сохранить Doxyfile в репо.
(Или, лучше, если вы используете autoconf , сохраните Doxyfile.in , чтобы номер версии текущего проекта был заменен на сгенерированный Doxyfile ] как часть шага configure .)
Если вы хотите, чтобы каждый, кто проверяет ваш проект, получил копию созданного Doxygen справочного руководства, сделайте его частью процесса сборки по умолчанию.