如何在Doxygen的File标签页中隐藏Markdown主页文件的路径
解决Doxygen Files标签显示Markdown主页文件路径的问题
我明白你的困扰——明明只想在Files标签里展示头文件,结果Markdown主页的路径也跟着出现了,还得被迫把md文件和头文件放一块。其实不用这么妥协,有几个灵活的配置方法可以让你把md文件放在单独目录,同时让Files标签只显示头文件:
方案1:用EXCLUDE选项排除Markdown文件
直接在Doxyfile里添加EXCLUDE配置,把你的主页md文件从文件列表中排除掉,同时保留它作为主页的功能:
INPUT = path/to/your/mainpage.md path/to/your/header/files USE_MDFILE_AS_MAINPAGE = path/to/your/mainpage.md SHOW_FILES = YES EXCLUDE = path/to/your/mainpage.md
原理是:Doxygen依然会处理这个md文件生成主页,但EXCLUDE会让它不被列入Files标签的文件列表中,完美分离功能和显示。
方案2:让INPUT只包含头文件,单独指定主页路径
如果不想把md文件放进INPUT范围,完全可以只让INPUT指向头文件目录,然后通过USE_MDFILE_AS_MAINPAGE直接指定md文件的路径:
INPUT = path/to/your/header/files USE_MDFILE_AS_MAINPAGE = path/to/separate/dir/mainpage.md SHOW_FILES = YES
这样INPUT里只有头文件,Files标签自然只会展示头文件,而Doxygen依然能找到并处理指定的md文件作为主页(只要路径书写正确,相对路径是相对于Doxyfile所在目录的)。
方案3:用FILE_PATTERNS过滤文件类型
通过指定FILE_PATTERNS,只让头文件类型被显示在Files标签里:
INPUT = path/to/your/mainpage.md path/to/your/header/files USE_MDFILE_AS_MAINPAGE = path/to/your/mainpage.md SHOW_FILES = YES FILE_PATTERNS = *.h *.hpp # 根据你的头文件类型调整
这个方法会让Doxygen只把匹配指定后缀的文件(也就是你的头文件)列入Files列表,md文件虽然在INPUT里,但因为不匹配后缀,不会被显示出来,同时不影响它作为主页的生成。
注意事项
- 所有路径如果用相对路径,都是相对于你的Doxyfile所在的目录,要确保路径书写准确;
- 如果用
EXCLUDE,要保证排除的路径和INPUT里的完全一致,否则可能达不到预期效果。
内容的提问来源于stack exchange,提问作者Lolo
相关产品推荐
相关产品推荐

