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

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

10 голосов
/ 07 июня 2011

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

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

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

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

Edit:

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

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

1 Ответ

17 голосов
/ 23 июля 2011

Я не уверен насчет 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, если вы перемещаете документы.

...