Doxygen для проекта, управляемого с помощью git?

Я работаю над проектом C++ и Objective C для iPhone. Я использую git в качестве системы контроля версий.

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

Я думал о паре вариантов:

1) Создайте HTML-документацию doxygen в папке проекта и сделайте ее «частью» проекта, чтобы она также была версионной и зафиксирована в git.

2) Создайте HTML-документацию doxygen в папке проекта и добавьте ее в .gitignore, чтобы каждый пользователь проекта отвечал за создание документов, а репозиторий git оставался нетронутым (кроме .gitignore).

Мы используем репозиторий git --bare на нашем основном сервере, поэтому смонтировать веб-страницу, содержащую HTML-файл doxygen, на сервере будет сложно (на самом деле вы не можете видеть файлы проекта с репозиторием git --bare, поэтому я выиграл не смогу увидеть сгенерированный doxygen HTML-документ, если я не загрузил его отдельно)

Может быть, я мог бы сделать что-то вроде cron-job, чтобы doxygen обновлялся на стороне сервера?

Помощь очень приветствуется.


git c++ iphone doxygen
person Goles    schedule 20.08.2010    source источник

Ответы (3)


arrow_upward
21
arrow_downward

Я считаю, что никогда не следует хранить сгенерированные файлы в репозитории исходного кода, особенно если они созданы общедоступными инструментами, такими как Doxygen, из файлов, которые находятся в репозитории. В случае с Doxygen вам нужно хранить только Doxyfile в репо.

(Или, что лучше, если вы используете autoconf, сохраните Doxyfile.in, чтобы текущий проект номер версии подставляется в сгенерированный Doxyfile как часть шага configure.)

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

person Warren Young    schedule 20.08.2010

arrow_upward
5
arrow_downward

Я согласен с Уорреном, но я бы добавил следующее:

Вы можете использовать ''ловушку после получения'' для автоматического обновления (отдельного) рабочего каталога каждый раз, когда происходит отправка в пустой репозиторий. Этот подход для поддержки веб-сайтов с контролем версий описан здесь http://toroid.org/ams/git-website-howto, и я использую его таким образом.

Мне кажется разумным, что вы можете добавить шаг к хуку для запуска Doxygen после обновления, что будет примерно тем, что вы ищете. Возможно, вам придется подумать о том, как сообщать об ошибках пользователю/коммиттеру, если Doxygen не работает, но это единственная проблема, которую я вижу.

person Eric Anderson    schedule 07.12.2011

arrow_upward
1
arrow_downward

Зарегистрируйте только файл конфигурации doxygen,

получите свой сервер непрерывной интеграции, чтобы создать документацию и опубликовать ее на внутреннем веб-сайте, а также поделиться URL-адресом с командой.

person Tim Abell    schedule 20.07.2012