Doxygen и git для автоматической информации о версии файла - PullRequest
Новая
       6

Doxygen и git для автоматической информации о версии файла

5 голосов
/ 22 февраля 2012

есть ли способ получить информацию о Doxygen из git: Например, для: 

@version
@author
@date

Информация должна автоматически включаться в комментарии Doxygen.

Для @version itбыло бы неплохо получить, возможно, информацию тега.

Большое спасибо заранее!

1 Ответ

0 голосов
/ 01 февраля 2019

Я понимаю, что это старый вопрос, но я просто пытался сделать то же самое.

Ни один из связанных ответов в комментариях не является отличным решением этой проблемы. Мы можем захотеть включить, например, git-ревизия в сгенерированной документации без использования git-фильтров и т. д. в наших рабочих источниках.

К счастью. Doxygen поддерживает использование переменных окружения в вашем Doxyfile и предоставляет различные настройки, которые можно использовать для размещения информации в вашем сгенерированном контенте. Параметр PROJECT_NUMBER предназначен для включения информации о контроле версий в вашу документацию.

Если у нас это есть в Doxyfile: 

PROJECT_NUMBER = $(PROJECT_NUMBER)

Вы можете запустить doxygen следующим образом, чтобы включить редакцию git в ваши сгенерированные документы: 

PROJECT_NUMBER=$(git rev-parse --short HEAD) doxygen

Вы не ограничены только идентификатором коммита. Для примера: 

PROJECT_NUMBER=$(git log -1 --format "%h (%cd)") doxygen

Это делает заголовок в моем сгенерированном HTML похожим на: 

<div id="projectname">MyProject
&#160;<span id="projectnumber">9dd847b (Fri Feb 1 15:36:13 2019 -0500)</span>
</div>
...