Подтвердить что ты не робот

Как я могу заставить Doxygen показать полный путь включения?

Как я могу заставить Doxygen показать полный путь включения?

Что я хочу сказать:

У меня есть класс foo::bar::bee, определенный в bee.hpp в следующей структуре каталогов:

foo
foo/bar
foo/bar/bee.hpp

Doxygen, когда он документирует класс foo::bar::bee, говорит, что вам нужно включить <bee.hpp>, но для моего программного обеспечения мне нужно <foo/bar/bee.hpp>

Как я могу заставить Doxygen сделать это? Есть ли опция предоставления "Включить флаги", например "-I", поэтому doxygen будет знать, где находится база?

Примечания:

  • FULL_PATH_NAMES уже установлен по умолчанию YES
  • Я не хочу предоставлять заголовок include явно для каждого класса, потому что слишком много из них. Я хочу, чтобы Doxygen сделал это автоматически.

Спасибо.

Ответ

Set:

STRIP_FROM_INC_PATH    = relative/path/to/include/directory
4b9b3361

Ответ 1

Взято непосредственно из подсказок в DoxyWizard:

STRIP_FROM_INC_PATH

Тег STRIP_FROM_INC_PATH можно использовать для удаления определенной пользователем части пути, упомянутого в документации класса, который сообщает читателю, какой заголовочный файл должен быть включен для использования класса. Если оставить пустым только имя файла заголовка, содержащего определение класса, используется. В противном случае следует указать пути включения, которые обычно передаются компилятору с использованием флага -I.