使用Doxygen时如何将一个Markdown文件内容直接嵌入另一个?
在Doxygen中嵌入Markdown页面内容而非仅显示链接
要实现将File1.md中\page ABC定义的内容直接嵌入到File2.md中,而非仅生成链接,可通过以下两种方式解决:
方式1:保留ABC独立页面同时嵌入内容
如果需要ABC继续作为独立页面存在,同时在File2中直接展示其内容,可使用Doxygen的\copydoc命令替代\subpage:
在File2.md中替换原有\subpage ABC为:
\copydoc ABC
该命令会将\page ABC定义的所有文档内容直接复制到File2的对应位置,同时ABC仍会作为独立页面出现在生成的文档导航中。
方式2:将File1内容作为片段嵌入(不保留独立页面)
如果不需要ABC作为独立页面,仅需将File1的内容整合到File2中,可按以下步骤操作:
- 删除File1.md中的
\page ABC命令; - 在File2.md的目标位置添加:
\input{File1.md}
Doxygen会直接将File1.md的内容插入到File2的对应位置,二者合并为同一个页面。
注意事项
- 确保Doxygen配置文件的
INPUT选项包含File1.md所在的目录,避免文件找不到的问题; - 使用
\input时,若文件路径为相对路径,需与Doxygen工作目录或INPUT配置的路径匹配; \copydoc可用于复制任何Doxygen可识别的实体内容(如页面、分组、类等),不限于\page定义的页面。
内容的提问来源于stack exchange,提问作者SoftwareTester
相关产品推荐
相关产品推荐

