包括另一个项目的文档
Include documentation of another project
我有一个库(例如'mylib')派生自另一个库(例如'GMatTensor'),例如通过派生自 class。现在我想在 'mylib' 的文档中包含 'GMatTensor' 例如显示派生方法。
什么有效
我的库结构如下:
docs/Doxyfile
include/mylib/mylib.hpp
我有一个 Doxyfile
包含
INPUT = ../include/mylib
然后我从安装位置包含外部库。我是用 conda 做的,所以有效的是
( cat Doxyfile ; echo "INPUT += ${CONDA_PREFIX}/include/GMatTensor") | doxygen -
什么不起作用
以上结果路径很长:
所以问题是:能否使 'external' 库的路径更具可读性(并减少系统依赖性)(无需克隆 'external' 库本地?
使用 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) 了解这些设置的定义以及特定情况下的要求。
我有一个库(例如'mylib')派生自另一个库(例如'GMatTensor'),例如通过派生自 class。现在我想在 'mylib' 的文档中包含 'GMatTensor' 例如显示派生方法。
什么有效
我的库结构如下:
docs/Doxyfile
include/mylib/mylib.hpp
我有一个 Doxyfile
包含
INPUT = ../include/mylib
然后我从安装位置包含外部库。我是用 conda 做的,所以有效的是
( cat Doxyfile ; echo "INPUT += ${CONDA_PREFIX}/include/GMatTensor") | doxygen -
什么不起作用
以上结果路径很长:
所以问题是:能否使 'external' 库的路径更具可读性(并减少系统依赖性)(无需克隆 'external' 库本地?
使用 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) 了解这些设置的定义以及特定情况下的要求。