2010-03-11 4 views
10

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

Спасибо.

Ответ

Set:

STRIP_FROM_INC_PATH = relative/path/to/include/directory 

ответ

12

взяты непосредственно из намеков в Doxywizard:

STRIP_FROM_INC_PATH

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

+0

Спасибо ... Я чувствую себя глупо. Я прочитал эту часть документации и не понял ее. – Artyom

+1

Ну, название опции предполагает различное поведение, поэтому не бейте себя :) –

Смежные вопросы