如何修改Doxygen生成的API网页中显示的头文件包含路径

核心逻辑 #

Doxygen自带路径裁剪配置能力，无需修改源码或注释内容，仅调整Doxyfile配置即可实现路径替换需求。 #

具体实现步骤 #

1. 手动修改Doxyfile配置 #

如果你的项目直接使用固定的Doxyfile生成文档，修改以下两个配置项即可：

• STRIP_FROM_PATH：填写需要从所有文件展示路径中删除的前缀，同时填入源码根目录和构建根目录，示例：

STRIP_FROM_PATH = /你的/源码/根目录/路径 /你的/构建/根目录/路径

该配置会让Doxygen输出文件路径时自动删除上述前缀，避免展示绝对路径和构建目录前缀。

• STRIP_FROM_INC_PATH：填写需要从#include展示路径中删除的前缀，填入项目所有公共头文件的搜索路径前缀，示例：

STRIP_FROM_INC_PATH = /你的/源码/根目录/路径/include /你的/构建/根目录/路径/include

该配置专门处理API页面顶部展示的#include路径，无论头文件存放在源码目录还是生成的构建目录，都会统一展示为你需要的相对路径格式。

2. 配合CMake自动生成配置（推荐） #

如果你的项目用CMake管理Doxygen生成流程，可以把配置逻辑固化到模板中，避免手动写死绝对路径：

1. 新建/修改Doxyfile.in模板，对应配置改为：

STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ @CMAKE_BINARY_DIR@
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include

2. 在CMakeLists.txt中添加配置生成逻辑：

configure_file(Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)

后续生成文档时直接使用构建目录下生成的Doxyfile即可，自动适配不同的构建目录和源码目录位置。

3. 验证基础配置 #

确认Doxygen的INPUT配置项中已经添加了构建目录下生成头文件的所在路径，否则Doxygen无法找到生成的version.hpp，不会生成对应的API文档。 #

效果验证 #

重新生成Doxygen文档后，version.hpp对应的API页面展示的#include路径和文件路径都会变为源码目录相对路径，不会再出现构建目录的绝对路径。

内容的提问来源于stack exchange，提问作者ChrisZZ