如何使用Doxygen组镜像C目录结构？

概述我需要在C代码上使用Doxygen的一些基本帮助.所有基本文档都很好,我想要帮助构建一长串文件和函数. 我有一个C源代码树,如下所示： src/ +--util/ +--file1.h +--file1.c +--file2.h +--file2.c +--stats/ +--file3.h +--etc/ 非常标准.目前doxygen生成所有文件的平 我需要在C代码上使用Doxygen的一些基本帮助.所有基本文档都很好,我想要帮助构建一长串文件和函数.

我有一个C源代码树,如下所示：

src/ +--util/    +--file1.h    +--file1.c    +--file2.h    +--file2.c +--stats/    +--file3.h +--etc/

非常标准.目前doxygen生成所有文件的平面文件列表.我们将src /的每个dub-dir称为“模块”,因此记录它似乎非常适合Doxygen模块/组.

我应该如何使用分组命令来镜像上面的目录结构？我想在生成的文档中有一个模块util,它链接到file1和file2文档.完全像JavaDoc会对待一个包.

添加/ addtogroup util& @ {标签到每个头文件生成了一个迷你站点,其中包含所有标题中所有数据结构等的扁平列表,这不是我期望或想要的.也许这就是doxygen组应该做的事情,即在跨多个文件实现代码时统一记录API？

解决方法 使用模块的一个更简单的选择是使用@page和@subpage.要获得与您描述的布局类似的内容,您可以使用以下内容：

@page util UtilThis page describes util module.@subpage file1@subpage file2@page stats StatsThis page describes stats module.@subpage file3@page etcBlah blah blah@page file1 file 1This is file 1.@page file2 file 2This is file 2.@page file3 file 3This is file 3.

这些注释当然可以包含在一个文件中或多个文件中.通常我会将@page file1放在file1.h中,将@page file2放在file2.h中,将@subpage注释放在更顶级的头文件或主源文件中.

总结

以上是内存溢出为你收集整理的如何使用Doxygen组镜像C目录结构？全部内容，希望文章能够帮你解决如何使用Doxygen组镜像C目录结构？所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。