Doxygen使用\include引入dox文件内容无法按格式渲染问题求助
问题原因
\include命令的设计定位就是插入纯文本/代码示例,Doxygen不会对\include导入的内容执行任何标记解析,只会当作预格式化文本展示,这是预期行为。\includedoc命令是Doxygen 1.9.2版本才新增的功能,作用就是导入外部文件并解析其中的Doxygen标记,你当前使用的1.8.17版本不支持该命令,所以使用后没有效果。
解决方法
方案一:升级Doxygen版本(推荐)
直接升级Doxygen到1.9.2或更高版本,保留你现有的文件结构,将\include替换为\includedoc即可,导入的内容会自动按照Doxygen规则渲染:
/*! \mainpage # Introduction \includedoc introduction.dox # Architecture \includedoc architecture.dox */
注意要将introduction.dox、architecture.dox所在的路径添加到Doxyfile的EXAMPLE_PATH配置项中,否则Doxygen会找不到文件。同时拆分的dox文件不需要额外加注释块包裹,直接写内容即可。
方案二:适配1.8.17版本(无需升级)
如果不能升级Doxygen版本,可以通过子页面引用的方式实现内容拆分:
- 给每个独立的dox文件定义为独立页面,例如
introduction.dox内容修改为:
/*! \page intro_page 项目介绍 Introduction =========== This is an introduction about this project. */
- 同理修改
architecture.dox,定义为\page arch_page 类架构说明。 - 在Doxyfile的
INPUT配置项中添加这两个dox文件的路径,确保Doxygen会扫描解析这两个文件。 - 修改
mainpage.dox的内容,通过\subpage命令引用子页面:
/*! \mainpage # 项目总览 - \subpage intro_page - \subpage arch_page */
如果希望内容直接嵌入到主页面而非跳转子页面,可以将拆分的内容定义为同名\section,直接写在独立dox文件的注释块中,并且将这些dox文件加入INPUT列表,Doxygen会自动把所有同名称的模块内容合并渲染。
内容的提问来源于stack exchange,提问作者radar101
相关产品推荐
相关产品推荐

