如何强制Doxygen显示完整的包含路径?

时间:2010-03-11 05:30:34

标签: c++ include doxygen code-documentation

如何强制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自动执行此操作。

感谢。

答案

集:

STRIP_FROM_INC_PATH    = relative/path/to/include/directory

1 个答案:

答案 0 :(得分:12)

直接从DoxyWizard的提示中获取:

  

STRIP_FROM_INC_PATH

     

STRIP_FROM_INC_PATH标记可用于去除类的文档中提到的路径的用户定义部分,该部分告诉读者为了使用类而包含哪个头文件。 如果留空,则仅使用包含类定义的头文件的名称。否则,应指定通常使用-I标志传递给编译器的包含路径。