Относительные пути к файлам в документации, сгенерированной doxygen

#doxygen #relative-path

#doxygen #относительный путь

Вопрос:

Я использую Doxygen 1.7.4 для Windows.

На странице «Список файлов» сгенерированной документации я хотел бы видеть относительные пути. Я установил FULL_PATH_NAMES = YES , чтобы иметь нечто большее, чем просто имя файла без пути, но это дает полные абсолютные пути.

Мне нужны только пути относительно каталога проекта. Я знаю, что могу использовать STRIP_FROM_PATH , но у меня проблема с подстановочными знаками. Мне нужно такое удаление пути, потому что этот проект создается на нескольких компьютерах (как репозиторий git), поэтому пути могут быть разными.

Можно ли использовать подстановочные знаки для этого параметра, или я должен установить doxyfile для каждой рабочей станции с разделением части абсолютного пути на strip?


Редактировать:

Я нашел что-то вроде того, что мне нужно, на веб-сайте doxygen: STRIP_FROM_PATH = $(QTDIR)/

Может быть, можно использовать одну из переменных doxyfile?

Ответ №1:

Я не уверен насчет Windows, но в Linux и OS X я могу создавать выходные данные в списке файлов, например

  • src/Utils.cpp [код]
  • src/Utils.h [код]
  • src/VectorMath.h [код]
  • test/src/test.cpp [код]

Установив FULL_PATH_NAMES в YES и STRIP_FROM_PATH в ../.. (т. е. путь к корневому каталогу проекта, который находится на два каталога выше того, где я создаю документы). Возможно, вам потребуется заменить разделитель каталогов на разделитель Windows.

Вам также нужно следить за обновлением файла Doxyfile при перемещении документов.

Комментарии:

1. 1 Протестировано и отлично работает и в Windows. Косая черта / является абсолютно допустимым разделителем каталогов в Windows, поэтому никаких изменений не требуется.