如何在Doxygen中配置忽略指定目录?
Doxygen目录排除配置及排除内容引用处理说明
一、GUI向导排除指定目录操作步骤
完成Doxygen基础的项目路径、输出格式配置后,按以下步骤操作即可排除不需要的目录:
- 切换到顶部的 Expert 标签页
- 在左侧的配置分类列表中找到
Input项,点击进入对应配置页 - 找到
EXCLUDE配置项,点击右侧的「+」按钮,在弹出的选择窗口中选中需要排除的目录,逐个添加完成即可 - 如果需要批量排除符合命名规则的目录/文件,可以找到同配置页下的
EXCLUDE_PATTERNS项,添加对应的匹配规则即可,比如排除所有名为test的子目录可添加规则*/test/*,排除所有非业务无关的说明文件可添加规则*.md,可根据自身需求灵活调整匹配规则 - 所有排除规则配置完成后,正常执行生成流程即可,Doxygen扫描源码时会自动跳过你指定的目录/文件。
二、代码引用被排除目录内容的处理规则
分两种场景处理:
- 已配置关联标签文件的情况
如果你提前为被排除的目录生成过Doxygen标签文件,并且在当前项目的Input配置页的TAGFILES项中关联了该标签文件,那么文档中对被排除内容的引用会自动生成跳转链接,指向对应预生成文档的对应位置。 - 未配置关联标签文件的情况
这是大多数普通用户的场景,此时Doxygen无法获取被排除目录内的函数、变量定义,文档中对应的引用会以普通纯文本展示,不会生成跳转链接,也不会自动补充被引用内容的定义、描述等信息。如果你的Doxygen开启了警告输出,生成过程中会输出unresolved reference to xxx的警告提示,你可以根据警告判断是否需要调整排除规则。
内容的提问来源于stack exchange,提问作者Crazy circuit
相关产品推荐
相关产品推荐

