【问题标题】:Doxygen include graphDoxygen 包含图
【发布时间】:2012-11-27 16:54:23
【问题描述】:
我知道有一个 doxygen 选项,用于显示包含图表,例如
a.cpp 包括 a.h 和 b.h
a.h 包括 c.h
c.h 包括 @987654327 @
但unistd.h 也包括<features.h> !
如何将来自“系统”标头的包含(如 unistd.h 或 windows.h)添加到 doxygen 的包含依赖关系图中?
【问题讨论】:
标签:
c++
c
header
include
doxygen
【解决方案1】:
虽然您可以按照 pmr 的建议将系统标头路径添加到 INPUT 变量中,但我会提出 不 将它们添加到包含图中的案例。
如果您想这样做以便可以说“啊,unistd.h 已经包含 features.h,所以我不需要自己包含它”,那么我建议您不要这样做。这是一个实现细节:你不应该关心它,因为它可能会在未来的版本中改变。如果您需要(例如)features.h 中的某些内容,那么您应该始终包含它,因为您不能依赖它已经被其他标题包含。
【解决方案2】:
这很难,因为这可能会记录包含在您自己文档中的这些标头中的代码。
通常,当在INPUT 指定的目录中找不到标头时,doxygen 将停止预处理。您可以将您的系统包含目录添加到INPUT 并希望最好。
一般来说,我更喜欢在库边界处包含文档。