如何让md文件仅在Doxygen 1.8.17首页显示而不出现在文件列表中

Doxygen 1.9.x 版本对MD文件作为主页、子页面的逻辑做了优化，会自动将这类非源码类说明MD排除在文件列表外，而1.8.17版本需要手动配置实现该效果，具体操作如下：

步骤1：调整MD文件标记（适配子页面引用场景） #

如果你的子页面需要在首页或其他位置交叉引用，给三个MD文件添加Doxygen内置页面标记：

• man_page.md 开头添加 @mainpage 项目文档首页，Doxygen可直接识别MD文件内的命令
• subpage_A.md 开头添加 @page subpage_a 子页面A标题
• subpage_B.md 开头添加 @page subpage_b 子页面B标题

后续可以在man_page.md里通过 @ref subpage_a 或 \subpage subpage_a 的方式跳转对应子页面。

步骤2：修改Doxyfile配置 #

打开你的Doxyfile文件，修改以下配置项：

• INPUT配置：仅保留需要出现在文件列表的源码目录，不要加入根目录的三个MD文件

  INPUT = api/
  

• EXTRA_FILES配置：将三个需要隐藏的MD文件加入该配置，Doxygen会解析这些文件的内容生成页面，但不会将它们纳入文件列表

  EXTRA_FILES = man_page.md \
                subpage_A.md \
                subpage_B.md
  

• USE_MDFILE_AS_MAINPAGE配置：指定man_page.md为文档首页

  USE_MDFILE_AS_MAINPAGE = man_page.md
  

兜底补充配置 #

如果上述操作完成后MD文件仍然出现在文件列表中，可额外添加全局排除规则：

EXCLUDE_PATTERNS = *.md

由于你已经在EXTRA_FILES中指定了需要解析的MD文件，这里的全局排除不会影响这三个文件的解析，只会拦截其他未指定的MD文件，彻底避免根目录MD被扫描进文件列表。

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