包括另一个项目的文档

Question

我有一个派生自另一个库（例如“GmatTensor”）的库（例如“mylib”），例如通过从一个类派生。现在我想在“mylib”的文档中包含“GmatTensor”，例如显示派生方法。

什么有效

对于我的以下结构的库：

docs/Doxyfile
include/mylib/mylib.hpp

我有一个Doxyfile 包含

INPUT = ../include/mylib

然后，我从安装位置包含外部库。我是用 conda 做的，所以有效的是

( cat Doxyfile ; echo "INPUT += ${CONDA_PREFIX}/include/GMatTensor") | doxygen -

什么不起作用

以上结果导致路径很长：

所以问题是：“外部”库的路径能否变得更易读（并且对系统的依赖性更小）（无需在本地克隆“外部”库？

Answer 1

在使用 doxygen 时，尤其是在使用完整路径名时（如 INPUT += ${CONDA_PREFIX}/include/GMatTensor") 中的设置，请注意

• FULL_PATH_NAMES
• STRIP_FROM_PATH
• STRIP_FROM_INC_PATH

请参阅文档 (https://www.doxygen.nl/manual/config.html#config_input)，了解这些设置的定义以及特定情况下的要求。