如何在Doxygen 1.10.0主页自动列出源文件及对应函数?
Doxygen 1.10.0主页自动生成源文件列表及函数清单方案
一、在主页嵌入与「Files > Files List」一致的文件表格
- 检查Doxygen配置文件(Doxyfile)关键参数:
- 确保
SHOW_FILES = YES(默认开启,保证文件列表页正常生成) - 按实际情况设置
FILE_PATTERNS,例如FILE_PATTERNS = *.c *.h - 若源文件分布在子目录,开启
RECURSIVE = YES
- 确保
- 在主页文档(如
mainpage.md或带\mainpage标记的代码注释块)中添加:
该命令会直接将自动生成的「Files List」页面的表格内容嵌入主页,格式与原页面完全一致。## 源文件列表 \copydoc files
二、在主页列出每个源文件对应的所有函数
提供两种实用实现方式:
方式1:按文件分组关联函数
- 给每个源文件添加文件级注释,用
\defgroup将文件内函数归为对应模块组,同时关联文件到该组:/** * \file demo.c * \brief 示例功能模块 * \defgroup demo_module 示例模块 * \ingroup demo_module */ /** * \ingroup demo_module * \brief 初始化示例模块 */ void demo_init(void) { /* 实现代码 */ } /** * \ingroup demo_module * \brief 执行示例操作 */ void demo_run(void) { /* 实现代码 */ } - 在主页中逐个引用文件文档(含函数列表):
每个文件的完整文档(包括函数列表)会被嵌入主页。## 各模块函数清单 - \copydoc demo.c - \copydoc utils.c
方式2:批量遍历生成(适用于多文件场景)
利用Doxygen 1.9+支持的\foreach命令批量处理所有源文件,需确保配置中ENABLE_PREPROCESSING = YES:
## 各源文件函数清单 以下是所有源文件对应的函数详情: \foreach \file in *.c *.h { ### \file \copydoc \file }
该方式会自动遍历指定后缀的文件,将每个文件的文档(含函数列表)嵌入主页。
内容的提问来源于stack exchange,提问作者ddomnik
相关产品推荐
相关产品推荐

