Как я могу заставить Doxygen показывать полный путь включения? - PullRequest
10 голосов
/ 11 марта 2010

Как я могу заставить 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
  • Я не хочу явно указывать заголовок включения для каждого класса, потому что их слишком много. Я хочу, чтобы Doxygen делал это автоматически.

Спасибо.

Ответ

Set:

STRIP_FROM_INC_PATH    = relative/path/to/include/directory

1 Ответ

12 голосов
/ 11 марта 2010

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

STRIP_FROM_INC_PATH

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

...