Doxygen中MD文件未按层级显示,如何恢复目录结构?
解决Doxygen显示Markdown文件目录层级的配置方法
要让Doxygen正确渲染项目的实际目录层级,需调整关键配置项并规范文件引用方式,具体步骤如下:
1. 调整Doxygen核心配置
在项目的Doxyfile配置文件中,确保以下参数设置正确:
RECURSIVE = YES:允许Doxygen递归扫描所有子目录下的文件SHOW_DIRECTORIES = YES:在生成的文档中启用目录结构显示INPUT = ./:将输入路径设为项目根目录,确保覆盖所有子目录(可根据实际路径调整)
2. 规范Markdown文件的内部链接
如果Markdown文件之间有互相引用,必须使用相对路径而非仅文件名。例如在folder1/item1.md中引用subfolder1/item3.md时,需写为:
[查看item3文档](subfolder1/item3.md)
3. 可选:自定义目录显示信息
若想给子目录添加说明或自定义名称,可在目标目录下创建README.md,并在文件开头添加Doxygen命令:
@dir folder1 @brief 这是folder1目录的功能说明
Doxygen会识别该配置,在文档中展示目录的自定义名称和描述。
4. 重新生成文档
删除之前生成的旧文档目录(默认是html文件夹),重新执行doxygen Doxyfile命令,生成的文档即可按照实际目录层级展示所有Markdown文件。
内容的提问来源于stack exchange,提问作者Ali Ahmad
相关产品推荐
相关产品推荐

