如何移除Doxygen生成的每个页面顶部的面包屑导航?
Doxygen 移除页面顶部面包屑导航路径问题
在每个 class、namespace 等类型的页面顶部,Doxygen 都会内置面包屑导航路径或称文件引用路径,你可按习惯称呼该元素。
需要移除的元素示意图如下:
已经尝试关闭了所有能想到的与生成 TOC/索引相关的设置,也使用了自定义布局文件,将 "navindex" 区块下的所有功能都关闭了,但依旧没有生效。
解决方案
你之前修改navindex区块不生效的原因是:Doxygen 的顶部面包屑导航路径由独立的navpath模块控制,和索引、TOC 生成模块是分开的,按照以下方法操作即可移除:
方法1:修改自定义布局文件(最彻底,推荐)
- 如果你已经生成了自定义布局 XML 文件(默认命名通常为
DoxygenLayout.xml),找到如下配置段:
<navpath> <name>Navigation path</name> <brief>Set of links that allow you to navigate back to the home page.</brief> </navpath>
- 直接删除整段
navpath节点,或者在节点上添加visible="no"属性,修改为:
<navpath visible="no"> <name>Navigation path</name> <brief>Set of links that allow you to navigate back to the home page.</brief> </navpath>
- 保存修改后重新运行 Doxygen 生成文档即可生效。
方法2:自定义 CSS 隐藏(无需修改布局,快速生效)
如果不想改动布局配置,可以通过自定义样式直接隐藏面包屑元素:
- 新建自定义 CSS 文件,例如
custom.css,添加如下代码:
#nav-path { display: none !important; }
- 打开你的 Doxyfile 配置文件,找到
HTML_EXTRA_STYLESHEET配置项,设置为你创建的 CSS 文件路径:
HTML_EXTRA_STYLESHEET = custom.css
- 重新生成文档,面包屑就不会在页面上显示。
方法3:自定义 HTML 头模板(彻底移除代码)
如果你需要完全从生成的 HTML 源码中删除面包屑相关代码,可以修改 HTML 头模板:
- 运行命令生成默认的 HTML 模板文件:
doxygen -w html header.html footer.html customdoxygen.css - 打开生成的
header.html,找到包含nav-path的相关代码段,整段删除 - 打开 Doxyfile 配置文件,找到
HTML_HEADER配置项,设置为修改后的header.html文件路径,重新生成文档即可。
内容的提问来源于stack exchange,提问作者JJT
相关产品推荐
相关产品推荐

